Fixes in dev docs #3333
Fixes in dev docs #3333
Conversation
| . Enable all internal debug logging: `-Dlog4j2.debug`. | ||
| This disables level-based xref:manual/status-logger.adoc[] filtering and effectively allows all status logs. | ||
| This turns-off level-based xref:manual/status-logger.adoc[] filtering and effectively allows all status logs. |
There was a problem hiding this comment.
We technically always use enable and disable to denote activation – I think we should stick to that.
There was a problem hiding this comment.
Disabled people will thank us for not using this terminology. We can keep it, but I think it is a negative wording. Please confirm you want to do that.
There was a problem hiding this comment.
Disabled people will thank us for not using this terminology.
You mean "people with disabilities" 😉? I don't think anybody thinks about physical disabilities, when reading a technical documentation, but if we are going to ban the disable verb, we should do it in the entire documentation.
There was a problem hiding this comment.
Please confirm you want to do that.
@grobmeier, I confirm that I prefer replacing turns-off with disables. Though I leave it to your discretion.
There was a problem hiding this comment.
How about "This allows for all kinds of status log messages to be written" or something like that.
Co-authored-by: Volkan Yazıcı <[email protected]>
| **Projects and XML schemas have different lifecycles!** | ||
| A new release of a project does not necessarily mean a new release of its XML schemas. | ||
| XML schemas might have been untouched, or they might contain minor changes while the project itself contains breaking changes, etc. | ||
| A project's new release does not necessarily mean a new release of its XML schemas. |
There was a problem hiding this comment.
| A project's new release does not necessarily mean a new release of its XML schemas. | |
| A new project release does not necessarily mean a new release of its XML schemas. |
| https://logging.apache.org/xml/ns | ||
| https://logging.apache.org/xml/ns/log4j-config-2.xsd"> | ||
| https://logging.apache.org/xml/ns | ||
| https://logging.apache.org/xml/ns/log4j-config-2.xsd"> |
There was a problem hiding this comment.
I prefer the previous indentation.
| * SLF4J forces your application to log ``String``s. | ||
| Log4j API supports logging any `CharSequence` if you want to log text, but also supports logging any `Object` as is. | ||
| It is the responsibility of the logging _implementation_ to handle this object, and we consider it a design mistake to limit applications to logging ``String``s. | ||
| The logging _implementation_ is responsible for handling this object, and we consider it a design mistake to limit applications to logging ``Strings``. |
There was a problem hiding this comment.
| The logging _implementation_ is responsible for handling this object, and we consider it a design mistake to limit applications to logging ``Strings``. | |
| The logging _implementation_ is responsible for handling this object, and we consider it a design mistake to limit applications to logging ``String``s. |
I prefer not to modify the name of classes.
| The solution is to provide the correct FQCN. | ||
| The easiest way to do this is to let Log4j generate the logger wrapper for you. | ||
| The easiest way is to let Log4j generate the logger wrapper for you. | ||
| Log4j comes with a Logger wrapper generator tool. | ||
| This tool was originally meant to support custom log levels and was moved to the | ||
| {logging-services-url}/log4j/transform/latest/index.html[Log4j Transform subproject]. |
There was a problem hiding this comment.
The tool was removed from Log4j Transform too, should we remove this paragraph?
| `<sourceBranch>-site-<environment>-out`:: | ||
| Branches used to serve the staging and production websites. | ||
| `out`-suffixed ones are automatically populated by CI, you are not supposed to touch them. | ||
| CI automatically populates `out`-suffixed ones; you are not supposed to touch them. |
There was a problem hiding this comment.
| CI automatically populates `out`-suffixed ones; you are not supposed to touch them. | |
| CI automatically populates `out`-suffixed branch names; you are not supposed to touch them. |
| [TIP] | ||
| ==== | ||
| You are strongly advised to spar with another maintainer first (see {logging-services-url}/support.html#discussions-maintainer[maintainer discussion channels]) before starting to code. | ||
| We strongly advise you to spar with another maintainer first (see {logging-services-url}/support.html#discussions-maintainer[maintainer discussion channels]) before starting to code. |
There was a problem hiding this comment.
Is "spar" the right term here? I only know that in context of practice martial arts fights (and apparently it's some part of a ship). I might go with something like "discuss" here.
| This page compiles a list of frequently asked questions. | ||
| If you don't find the answer to your question, please consult to link:{logging-services-url}/support.html[the support page]. | ||
| If you don't find the answer to your question, please consult the link:{logging-services-url}/support.html[the support page]. |
There was a problem hiding this comment.
| If you don't find the answer to your question, please consult the link:{logging-services-url}/support.html[the support page]. | |
| If you don't find the answer to your question, please consult link:{logging-services-url}/support.html[the support page]. |
"The" is repeated otherwise.
| . Enable all internal debug logging: `-Dlog4j2.debug`. | ||
| This disables level-based xref:manual/status-logger.adoc[] filtering and effectively allows all status logs. | ||
| This turns-off level-based xref:manual/status-logger.adoc[] filtering and effectively allows all status logs. |
There was a problem hiding this comment.
How about "This allows for all kinds of status log messages to be written" or something like that.
4 participants
Improved writing (active/passive, typos, grammar) for several pages.
FInal checks for MS30: #1867