-
Notifications
You must be signed in to change notification settings - Fork 38
Feature 1667 doc conventions #2397
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
Conversation
@lisagoodrich I selected the Beta 2 cycle under Project, and changed the Milestone from METplus-5.0.3 Bugfix to METplus-6.0.0. |
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.
@lisagoodrich Having reviewed this and worked on it so much recently, this was a quick review process. Thank you so much for all of your work on this task. This is an excellent and valuable addition to Contributor's Guide. I approve this request.
Pull Request Testing
Describe testing already performed for these changes:
This was a big undertaking. I added in all of the items from the original issue. But there were quite a few more topics to cover. See the section headers for all of the new items. Many of the items were pulled from "METplus Sphinx Documentation Guide". There were MANY different iterations of this work. They can be found in Lisa's personal directory, "2023 METplus Cont. Guide Overview and Conventions".
Recommend testing for the reviewer(s) to perform, including the location of input datasets, and any additional instructions:
. Feel free to do a cursory check of https://metplus.readthedocs.io/en/feature_1667_doc_conventions/Contributors_Guide/documentation.html#underline section 10.2. It has been reviewed in detail.
Once this is committed, I'd like to share this information at a METplus All Hands Meeting.
Do these changes include sufficient documentation updates, ensuring that no errors or warnings exist in the build of the documentation? [Yes there are no warnings]
Do these changes include sufficient testing updates? [No]
Will this PR result in changes to the test suite? [No]
If yes, describe the new output and/or changes to the existing output:
Please complete this pull request review by 11/3/23.
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