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

Per #73, reorganized use case documentation and added templates for future use #74

Merged
merged 3 commits into from
Jan 27, 2025

Conversation

briannen
Copy link
Collaborator

@briannen briannen commented Jan 16, 2025

Documentation only changes, see https://i-wrf--74.org.readthedocs.build/en/74/Users_Guide/usecases.html to review

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

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

@briannen briannen requested a review from jaredalee January 16, 2025 17:25
@briannen briannen added the component: documentation Documentation issues label Jan 16, 2025
@briannen briannen added this to the I-WRF 0.3 milestone Jan 16, 2025
@briannen briannen linked an issue Jan 16, 2025 that may be closed by this pull request
20 tasks
@briannen briannen self-assigned this Jan 16, 2025
@briannen briannen marked this pull request as ready for review January 16, 2025 17:29
jaredalee
jaredalee previously approved these changes Jan 27, 2025
Copy link
Contributor

@jaredalee jaredalee left a comment

Choose a reason for hiding this comment

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

Only one requested change: Please remove the heading/link for the Generic CONUS "interesting weather". At one point we thought we were going to pursue something like that, but then the Hurricane Matthew case wound up serving as our initial tutorial/demo entry point instead. But once you make those small changes, I approve this PR without needing a second review, and you can go ahead and merge them. Thanks for doing this.

@@ -2,32 +2,27 @@
Use Cases
*********

Generic CONUS interesting weather
Generic CONUS "interesting weather"
Copy link
Contributor

Choose a reason for hiding this comment

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

Please remove the heading/link for the Generic CONUS "interesting weather". At one point we thought we were going to pursue something like that, but then the Hurricane Matthew case wound up serving as our initial tutorial/demo entry point instead.

@briannen
Copy link
Collaborator Author

@jaredalee I do need another approving review in order to merge.

Copy link
Contributor

@jaredalee jaredalee left a comment

Choose a reason for hiding this comment

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

Thanks, @briannen. Good to go now.

@briannen briannen merged commit dc1952f into main Jan 27, 2025
3 checks passed
@briannen briannen deleted the feature/73_documentation_updates branch January 27, 2025 17:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Documentation issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reorganize use case documentation and provide a template for future use
2 participants