Make it easier to find information about the logging levels in logging.md #1852
Conversation
Interlink to Log Levels -section in all instances where the available logging levels are discussed. Previously the links pointed to [example rabbitmq.conf](https://github.com/rabbitmq/rabbitmq-server/blob/v3.13.x/deps/rabbit/docs/rabbitmq.conf.example) which doesn't provide a list of all available logging levels.
Previously the example config file was mentioned related to logging levels but these links were removed in commit a99eb33. To keep the useful link to the example config a new paragraph was added in the summary of _Configuration_ section.
|
@MiriPii Please sign the Contributor License Agreement! Click here to manually synchronize the status of this Pull Request. See the FAQ for frequently asked questions. |
|
@MiriPii Thank you for signing the Contributor License Agreement! |
| @@ -77,6 +77,8 @@ if the environment variable is set, the configuration key `log.file` will not ha | |||
| RabbitMQ starts logging early on node start. See the [Configuration guide](./configure) | |||
| for a general overview of how to configure RabbitMQ. | |||
|
|
|||
| The full list of available configuration options can be found in the [example rabbitmq.conf -file](https://github.com/rabbitmq/rabbitmq-server/blob/v3.13.x/deps/rabbit/docs/rabbitmq.conf.example). | |||
There was a problem hiding this comment.
Could you please remove the "-" before "file"? Our Doc writer is unavailable right now to confirm but we don't use this anywhere in the docs AFAIK.
There was a problem hiding this comment.
We don't need to mention that it is a file, it should be obvious to the reader.
There was a problem hiding this comment.
I don't see why we need to link to this example file from this guide, given that we already link to the configuration guide.
| @@ -107,7 +109,7 @@ The following example instructs RabbitMQ to log to a file at the `debug` level: | |||
| log.file.level = debug | |||
| ``` | |||
|
|
|||
| Supported log levels ca be found in the [example rabbitmq.conf file](https://github.com/rabbitmq/rabbitmq-server/blob/v3.13.x/deps/rabbit/docs/rabbitmq.conf.example). | |||
| > Supported log levels are discussed in the [Log Levels -section](#log-levels) found below. | |||
There was a problem hiding this comment.
Likewise, could you please remove the "-" before "section"?
| @@ -217,7 +219,7 @@ The following example instructs RabbitMQ to use the `debug` logging level when l | |||
| log.console.level = debug | |||
| ``` | |||
|
|
|||
| Supported log levels ca be found in the [example rabbitmq.conf file](https://github.com/rabbitmq/rabbitmq-server/blob/v3.13.x/deps/rabbit/docs/rabbitmq.conf.example). | |||
| > Supported log levels are discussed in the [Log Levels -section](#log-levels) found below. | |||
There was a problem hiding this comment.
Likewise, could you please remove the "-" before "section"?
|
I will credit @MiriPii in an alternative version. We don't need to link to the example config file from the Logging guide, there's already a Configuration guide link, in fact, more than one. The Log Levels section can be made more prominent but it is already present in the ToC. So adding it below the two examples that configure logging (to a file and to standard streams) should be enough. |
|
@MiriPii a version of these changes should be live in a few minutes. Thank you for contributing to the docs. |
This PR creates interlinks to the Logging Levels section in logging.md and moves the mention/link to the example config file to the summary of Configuration section.
In more detail
The old links (on lines 110 and 220)suggest that the list of available logging levels can be found from the example rabbitmq.conf -file which is false.
However, the logging.md already has a separate section on the topic with a clear table of the available logging levels and it would be helpful to guide the reader into that section instead.