Bugfix main_v5.0 Fix broken documentation links #2003
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Rename configuration RST file back to systemconfiguration to prevent broken links in config files.
Also added sub-heading for info about instances names in the process list so we can link to that info from the tutorial.
Check that table of contents [+] icons are working properly: https://metplus.readthedocs.io/en/bugfix_main_v5.0_doc_links/Users_Guide/systemconfiguration.html
Pull Request Testing
Confirmed documentation built successfully and links in config files will not be broken.
Tested using a link from a config file but replacing latest with bugfix_main_v5.0_doc_links:
https://metplus.readthedocs.io/en/bugfix_main_v5.0_doc_links/Users_Guide/systemconfiguration.html#process-list
Check that above link works properly and optionally test other links from config files by replacing latest with bugfix_main_v5.0_doc_links in the URL.
Do these changes include sufficient documentation updates, ensuring that no errors or warnings exist in the build of the documentation? [Yes]
Do these changes include sufficient testing updates? [Yes]
Will this PR result in changes to the test suite? [No]
Please complete this pull request review by 1/5/2023.
Pull Request Checklist
See the METplus Workflow for details.
Select: Reviewer(s)
Select: Organization level software support Project or Repository level development cycle Project
Select: Milestone as the version that will include these changes