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

Move release notes into its own chapter in the User's Guide #2298

Closed
19 of 21 tasks
jprestop opened this issue Oct 12, 2022 · 2 comments · Fixed by #2304
Closed
19 of 21 tasks

Move release notes into its own chapter in the User's Guide #2298

jprestop opened this issue Oct 12, 2022 · 2 comments · Fixed by #2304
Assignees
Labels
component: documentation Documentation issue priority: medium Medium Priority reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project reporting: DTC NOAA R2O NOAA Research to Operations DTC Project requestor: METplus Team METplus Development Team type: task An actionable item of work
Milestone

Comments

@jprestop
Copy link
Collaborator

jprestop commented Oct 12, 2022

Describe the Task

Move the MET Release Notes section out of the Overview chapter and into it's own chapter (under Overview - the Release Notes will become chapter 2). Rename in the following way:

  • 1.5 MET Release Notes -> 2 MET Release Information
  • Modify the index.rst file to add the new chapter "release-notes" after "overview"
  • Create a new 2.1 section called MET Release Notes
  • The existing information in current sections in 1.5.1 - 1.5.3 should be moved to 2.1.1 - 2.1.3.
  • Create a new 2.2 section called MET Upgrade Instructions (with paragraph text "Upgrade instructions will be listed here if they are applicable for this release.")

This work will require changing the types of headers to follow the standard guidelines:
https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

# with overline, for parts
* with overline, for chapters
=, for sections
-, for subsections
^, for subsubsections
“, for paragraphs

Time Estimate

<1 day

Sub-Issues

Consider breaking the task down into sub-issues.

  • Add a checkbox for each sub-issue here.

Relevant Deadlines

MET-11.0.0-beta4 release

Funding Source

2792541

Define the Metadata

Assignee

  • Select engineer(s) or no engineer required
  • Select scientist(s) or no scientist required

Labels

  • Select component(s)
  • Select priority
  • Select requestor(s)

Projects and Milestone

  • Select Repository and/or Organization level Project(s) or add alert: NEED PROJECT ASSIGNMENT label
  • Select Milestone as the next official version or Future Versions

Define Related Issue(s)

Consider the impact to the other METplus components.

Task Checklist

See the METplus Workflow for details.

  • Complete the issue definition above, including the Time Estimate and Funding Source.
  • Fork this repository or create a branch of develop.
    Branch name: feature_<Issue Number>_<Description>
  • Complete the development and test your changes.
  • Add/update log messages for easier debugging.
  • Add/update unit tests.
  • Add/update documentation.
  • Push local changes to GitHub.
  • Submit a pull request to merge into develop.
    Pull request: feature <Issue Number> <Description>
  • Define the pull request metadata, as permissions allow.
    Select: Reviewer(s) and Linked issues
    Select: Repository level development cycle Project for the next official release
    Select: Milestone as the next official version
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.
@jprestop jprestop added component: documentation Documentation issue type: task An actionable item of work priority: medium Medium Priority requestor: METplus Team METplus Development Team labels Oct 12, 2022
@jprestop jprestop added this to the MET 11.0.0 milestone Oct 12, 2022
@jprestop jprestop moved this from Backlog to In Progress in MET-11.0.0-beta4 (11/02/22) Oct 13, 2022
@lisagoodrich
Copy link
Contributor

My feature branch is : feature_2296_release_notes_move

On the pull request I linked to Move release notes into its own chapter #2298. Please note the numbers are different. I didn't know how to handle this.

@lisagoodrich
Copy link
Contributor

Work is completed.

Repository owner moved this from In Progress to Done in MET-11.0.0-beta4 (11/02/22) Oct 19, 2022
@JohnHalleyGotway JohnHalleyGotway changed the title Move release notes into its own chapter Move release notes into its own chapter in the User's Guide Oct 30, 2022
@TaraJensen TaraJensen added reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project reporting: DTC NOAA R2O NOAA Research to Operations DTC Project labels Jan 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Documentation issue priority: medium Medium Priority reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project reporting: DTC NOAA R2O NOAA Research to Operations DTC Project requestor: METplus Team METplus Development Team type: task An actionable item of work
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

3 participants