Add documentation covering all current aspects of the configuration file

[bconn98]

Add a markdown document detailing all the configuration options provided by log4rs.

Fixes: #291
Fixes: #304
Fixes: #306

[CaliViking]

Thank you @bconn98

[tylerhjones]

Thanks 👍🏻

[dertin]

Hey @estk

It's been a while since I've seen a PR approved, I don't see much activity. What are the plans to approve this PR and the others pending review?

[bconn98]

Hey @estk

It's been a while since I've seen a PR approved, I don't see much activity. What are the plans to approve this PR and the others pending review?

@dertin I'm working with him to start getting PRs moving again. Look for updates soon!

[c-git]

Thank you very much, I really think this is a very good library with lot's of potential to be even better.

[estk]

@bconn98 thanks so much for your work on this. I have a couple procedural comments:

• Can you please add a md lint to CI which lints the docs folder?

  • See https://github.com/marketplace/actions/markdown-linting-action

• Can you set up our docs.rs to pull in this explainer?

• Can you please also review the docs there and be sure there is no duplications

• Please double check for consistent capitalization of titles and sections

• Please double check grammar and wording for clear comms

Thanks so much!
@estk

[bconn98]

@estk Thanks for the comments. Should be all set. Looks like the workflows need approved prior to executing though.

[estk]

@bconn98 looking good, can you split out the markdown lint to a separate CI job?

You'll also need to bump the minimum rust version in the CI to 1.57

[bconn98]

@estk ✅ and ✅

[estk]

seems like there is a rustfmt issue.
Also the markdown-lint is not actually linting anything, maybe we need to tell it about the .md files?

[bconn98]

@estk 👍 actually ran the linters locally so should be good for both MD's and the rustfmt

[bconn98]

Looks like there are version issues. I'll fight these tomorrow.

[estk]

fwiw im open to moving to 1.60 as a minimum but let split that into a sep PR

[estk]

alright, i think we're in the home stretch.
I generated the cargo docs and realized we need to move the docs you wrote to the config module. Its just too much for the root page.

Can you also replace the configuration section with a link to the config page and dedupe the text in the first para?
Can you also add a link to the examples folder in the first para?

[estk]

🎉