-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: Configuration file pages as explanation and reference (Diátaxis) #10416
Conversation
…cs/configuration-reference-explanation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did some content updates here, I think we're close..
@ericholscher what do you think about adding a small section about configuration files and implicit defaults, i.e. the topic of using |
I think we can tackle that later. I don't want to expand the scope of this PR, so we cna can get it merged. |
…nce directly (because we didn't have any other resources), should add the how-to
This PR proposes to:
config-file/index
to an explanation page (we could refactor the location, but in the special case of config-file contents, we currently have it all in this folder)config-file/index
that's currently making users go through an unnecessary intermediate stepMight wanna add a note about the upcoming requirements to have a configuration file w/ a link to the blog post? Or do that later?
Fixes: #8648
Refs: #9747
This PR supersedes #9921
📚 Documentation previews 📚
docs
): https://docs--10416.org.readthedocs.build/en/10416/dev
): https://dev--10416.org.readthedocs.build/en/10416/