doc: mention `warn` and `error` as available log levels #716

Merged

lx merged 1 commit from emilylange/garage:doc/mention-warn-error-log-levels into main

2024-02-13 08:13:23 +00:00

emilylange commented

2024-02-12 16:58:50 +00:00

Contributor

For some users, this might be their first time being interacting with the env_logger crate.
As such, they might not be aware that less verbose log levels exist.
Some might not want to log every incoming request, for example.

This commit also adds syntax hints to the code-fence for bash for better syntax highlighting of that section, and repeats itself multiple times, that info is, in fact, the default.

No changes to the recommendation of log levels were made.

Motivation for this change: Link to message in #garage:deuxfleurs.fr

Will fix the nixos/garage module's services.garage.logLevel enum accordingly¹^/²

For some users, this might be their first time being interacting with the `env_logger` crate. As such, they might not be aware that less verbose log levels exist. Some might not want to log every incoming request, for example. This commit also adds syntax hints to the code-fence for bash for better syntax highlighting of that section, and repeats itself multiple times, that `info` is, in fact, the default. No changes to the recommendation of log levels were made. Motivation for this change: [Link to message in `#garage:deuxfleurs.fr`](https://matrix.to/#/!PRbIZeDKGloDOnjyyw:deuxfleurs.fr/$9wOt2aV6jNseOdSfhSTM7fBbwyjD5kCnTgkwIesiS6U?via=deuxfleurs.fr&via=matrix.org&via=cyberia.club) Will fix the `nixos/garage` module's `services.garage.logLevel` enum accordingly[^1]<sup>/</sup>[^2] [^1]: https://github.com/NixOS/nixpkgs/blob/d934204a0f8d9198e1e4515dd6fec76a139c87f0/nixos/modules/services/web-servers/garage.nix#L32-L37 [^2]: https://search.nixos.org/options?channel=unstable&show=services.garage.logLevel&query=services.garage.logLevel

emilylange force-pushed doc/mention-warn-error-log-levels from 905ea27e40 to c86ac264cb

2024-02-12 17:01:29 +00:00

Compare