Skip to content
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

Bugfix main_v5.0 Fix broken documentation links #2003

Merged
merged 4 commits into from
Jan 5, 2023

Conversation

georgemccabe
Copy link
Collaborator

@georgemccabe georgemccabe commented Jan 4, 2023

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

  • Describe testing already performed for these changes:

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

  • Recommend testing for the reviewer(s) to perform, including the location of input datasets, and any additional instructions:

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.

  • Add any new Python packages to the METplus Components Python Requirements table.
  • Review the source issue metadata (required labels, projects, and milestone).
  • Complete the PR definition above.
  • Ensure the PR title matches the feature or bugfix branch name.
  • Define the PR metadata, as permissions allow.
    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
  • After submitting the PR, select Development issue with the original issue number.
  • After the PR is approved, merge your changes. If permissions do not allow this, request that the reviewer do the merge.
  • Close the linked issue and delete your feature or bugfix branch from GitHub.

Copy link
Contributor

@lisagoodrich lisagoodrich left a comment

Choose a reason for hiding this comment

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

The subsection is correct and follows the documentation standard.

I clicked on the Table of Contents and it's going to the correct area. I tested all of the subsections in chapter 5 and some of the other chapters for good measure.

BUT it's still missing the "+" to open up the Table of Contents further.

@lisagoodrich
Copy link
Contributor

The table of contents [+] icons are working properly. I approve this request.

@georgemccabe georgemccabe merged commit 98adc5b into main_v5.0 Jan 5, 2023
@georgemccabe georgemccabe deleted the bugfix_main_v5.0_doc_links branch January 5, 2023 20:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

2 participants