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

Feature #2844 release_guide_dropdowns #2847

Merged
merged 10 commits into from
Dec 20, 2024

Conversation

JohnHalleyGotway
Copy link
Collaborator

@JohnHalleyGotway JohnHalleyGotway commented Dec 19, 2024

Pull Request Testing

Swinging for the fence here. I added Instructions dropdowns basically throughout the Release Guide. Replaced what I considered to be overly organized sub-sub-sub sections with bullets instead so they could fit in the dropdown. Preceeded each dropdown with a 1-sentence summary.

  • Describe testing already performed for these changes:

    Built locally to confirm that the changes render well with no warnings.

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

Throughout, I didn't change the content much... basically just the formatting.

Link to RTD documentation: https://metplus.readthedocs.io/en/feature_2844_release_guide_dropdowns/Release_Guide/index.html

  • @georgemccabe please review the formatting of the METplus and the coordinated release instructions.

  • @bikegeek please review the formatting of the METcalcpy and METplotpy release instructions.

  • @jprestop please review the formatting of the METdataio and METviewer release instructions.

  • @mollybsmith-noaa please review the formatting of the METexpress release instructions. Molly I also note that the AWS instructions COULD BE removed, but wanted to confirm with you first before doing so.

  • 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? [No]
    None needed.

  • Will this PR result in changes to the test suite? [No]

    If yes, describe the new output and/or changes to the existing output:

  • Do these changes introduce new SonarQube findings? [No]

    If yes, please describe:

  • Please complete this pull request review by [Fri 12/20/24].

Pull Request Checklist

See the METplus Workflow for details.

  • Add any new Python packages to the METplus Components Python Requirements table.
  • For any new datasets, an entry to the METplus Verification Datasets Guide.
  • 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) and Development issue
    Select: Milestone as the version that will include these changes
    Select: Coordinated METplus-X.Y Support project for bugfix releases or METplus-Wrappers-X.Y.Z Development project for official releases
  • After submitting the PR, select the ⚙️ icon in the Development section of the right hand sidebar. Search for the issue that this PR will close and select it, if it is not already selected.
  • 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

@mollybsmith-noaa mollybsmith-noaa left a comment

Choose a reason for hiding this comment

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

The METexpress section looks good to me. You're correct that the AWS instructions can be removed.

jprestop
jprestop previously approved these changes Dec 19, 2024
Copy link
Collaborator

@jprestop jprestop left a comment

Choose a reason for hiding this comment

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

The formatting of the METdataio and METviewer release instructions looks good to me. Thank you!

Copy link
Collaborator

@georgemccabe georgemccabe left a comment

Choose a reason for hiding this comment

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

These changes look great, thank you for doing this, @JohnHalleyGotway!

Copy link
Contributor

@bikegeek bikegeek left a comment

Choose a reason for hiding this comment

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

METcalcpy and METplotpy look good.

@JohnHalleyGotway JohnHalleyGotway merged commit ea4c625 into develop Dec 20, 2024
3 checks passed
@JohnHalleyGotway JohnHalleyGotway deleted the feature_2844_release_guide_dropdowns branch December 20, 2024 16:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🏁 Done
Development

Successfully merging this pull request may close these issues.

Documentation: Enhance the Release Guide documentation by consistently adding dropdown instructions
5 participants