Skip to content

docs: improve docs about how to work with logs#3626

Merged
georglauterbach merged 4 commits intomasterfrom
docs-logs
Nov 8, 2023
Merged

docs: improve docs about how to work with logs#3626
georglauterbach merged 4 commits intomasterfrom
docs-logs

Conversation

@georglauterbach
Copy link
Copy Markdown
Member

Description

  1. I added information on the recently adopted less / nano
  2. I added information about /var/log/mail/

I think users sometimes lack the information on where to find our logs and how to work with them. This PR should help clarify the issue even further.

Type of change

  • Improvement (non-breaking change that does improve existing functionality)
  • This change is a documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code

Most importantly,

1. I added information on the recently adopted `less` / `nano`
2. I added information about `/var/log/mail/`
@georglauterbach georglauterbach added kind/improvement Improve an existing feature, configuration file or the documentation area/documentation labels Nov 7, 2023
@georglauterbach georglauterbach added this to the v13.0.0 milestone Nov 7, 2023
@georglauterbach georglauterbach self-assigned this Nov 7, 2023
@georglauterbach georglauterbach changed the title docs: improvide docs about how to work with logs docs: improve docs about how to work with logs Nov 7, 2023
Copy link
Copy Markdown
Member

@polarathene polarathene left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll apply the suggestions.

Comment thread docs/content/config/debugging.md Outdated
Comment thread docs/content/config/debugging.md Outdated
polarathene
polarathene previously approved these changes Nov 8, 2023
Copy link
Copy Markdown
Member

@polarathene polarathene left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

Comment thread docs/content/config/debugging.md Outdated
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Nov 8, 2023

Documentation preview for this PR is ready! 🎉

Built with commit: 6053bb7

@georglauterbach
Copy link
Copy Markdown
Member Author

Thanks for the review - I will merge this as you seem happy with it :D

@georglauterbach georglauterbach merged commit 8c0777b into master Nov 8, 2023
@georglauterbach georglauterbach deleted the docs-logs branch November 8, 2023 09:49
reneploetz pushed a commit to reneploetz/docker-mailserver that referenced this pull request Nov 14, 2023
* improvide docs about how to work with logs

Most importantly,

1. I added information on the recently adopted `less` / `nano`
2. I added information about `/var/log/mail/`

* fix typos

* Apply suggestions from code review

* Update docs/content/config/debugging.md

---------

Co-authored-by: Brennan Kinney <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation kind/improvement Improve an existing feature, configuration file or the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants