Docs: Configuration file how-to guide (#10301)
* WIP. Completed introduction and file location sections.
* WIP. Converted note admonition to a section.
* WIP. Began config file requirements.
Pausing so Manuel can create a bulleted list explaining what the
requirements actually are.
* Apply suggestions from code review by @benjaoming and @agjohnson
Co-authored-by: Anthony <aj@ohess.org>
* Make it build
* rtd's rst header coventions
* Header as how-to + shorten intro a bit more
* YAML: Reference Wikipedia
* Use sphinx-copybutton
* Start managing use of example configuration files
* Turn tip into seealso
* Updates the how-to with more content editing, aligning more with a step-by-step guide
* Fix a syntax err
* Add some more fluffy text to bind the flow together
* Remove redundant sentence
* Further refinements to the step-by-step structure
* Add Next Steps section
* More step-by-step flow and copy editing
* Adds a tip (inspired by possible Configuration File howto UX)
* More content for build.commands
* Apply suggestions from @agjohnson code review with some additional suggestions from @benjaoming
Co-authored-by: Anthony <aj@ohess.org>
* Trim the weird .readthedocs.yaml comment
* Refactor: Remove the "bare" echo example and use Docusaurus instead. Remove section about custom commands and instead have it hidden in a tab
* Fix some references
* Fix a crashed sentence
* Eliminate seealso from Docusaurus section (an almost identical one is in Next Steps)
* Remove Docusaurus template
* Remove section on adjusting for Docusaurus support
* Point to the YAML site and simplify copy on our YAML note
* Change note on Ubuntu image and package versions
* Doc lint
---------
Co-authored-by: Nik Blanchet <nblanchet3@bloomberg.net>
Co-authored-by: Benjamin Balder Bach <benjaoming@gmail.com>
Co-authored-by: Anthony <aj@ohess.org>
Co-authored-by: Benjamin Bach <benjamin@readthedocs.org>
