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

Updates release notes for v11.1 for function removal. #2630

Merged
merged 4 commits into from
Jul 28, 2023

Conversation

DanielAdriaansen
Copy link
Contributor

@DanielAdriaansen DanielAdriaansen commented Jul 27, 2023

Closes #2624.

Expected Differences

  • Do these changes introduce new tools, command line arguments, or configuration file options? [Yes or No]

    If yes, please describe:

  • Do these changes modify the structure of existing or add new output data types (e.g. statistic line types or NetCDF variables)? [Yes or No]

    If yes, please describe:

Pull Request Testing

  • Describe testing already performed for these changes:

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

  • Do these changes include sufficient documentation updates, ensuring that no errors or warnings exist in the build of the documentation? [Yes or No]

  • Do these changes include sufficient testing updates? [Yes or No]

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

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

  • Please complete this pull request review by [Fill in date].

Pull Request Checklist

See the METplus Workflow for details.

  • 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.

@DanielAdriaansen
Copy link
Contributor Author

I am trying to view the docs here: https://met.readthedocs.io/en/hotfix_update_v11.1_release_notes, but it doesn't seem to be working.

@DanielAdriaansen DanielAdriaansen linked an issue Jul 27, 2023 that may be closed by this pull request
21 tasks
@jprestop
Copy link
Collaborator

@DanielAdriaansen Only branches that begin with the following prefixes have documentation generated automatically:
- develop
- develop-ref
- feature_*
- main_*
- bugfix_*

as listed in the GitHub Actions workflow file https://github.com/dtcenter/MET/blob/main_v11.0/.github/workflows/documentation.yml

Since this branch begins with "hotfix" the documentation was not automatically generated. However, the PR generates a build of documentation, which you can see here:
https://met--2630.org.readthedocs.build/en/2630/Users_Guide/release-notes.html

@JohnHalleyGotway JohnHalleyGotway requested review from jprestop and removed request for JohnHalleyGotway July 27, 2023 17:12
@jprestop
Copy link
Collaborator

@DanielAdriaansen I added some suggestions for indention to align the code block with the bulleted list.

@DanielAdriaansen
Copy link
Contributor Author

@DanielAdriaansen I added some suggestions for indention to align the code block with the bulleted list.

Thanks @jprestop! I am happy with things now. Feel free to approve based on how the docs look here:
https://met--2630.org.readthedocs.build/en/2630/Users_Guide/release-notes.html#met-version-11-1-0-upgrade-instructions

And then merge. Appreciate your help!

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.

Great @DanielAdriaansen! It looks good to me too. Thanks for your work on this task! I approve this request.

@jprestop jprestop merged commit 6674522 into main_v11.1 Jul 28, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Documentation issue
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Consider adding instructions for removing import of convert_point_data
2 participants