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

ReadTheDocs: Set up gh-pages redirection and update Release Guide #836

Closed
8 of 21 tasks
jprestop opened this issue Mar 9, 2021 · 2 comments · Fixed by #870
Closed
8 of 21 tasks

ReadTheDocs: Set up gh-pages redirection and update Release Guide #836

jprestop opened this issue Mar 9, 2021 · 2 comments · Fixed by #870
Assignees
Labels
component: documentation Documentation issue priority: high High Priority reporting: DTC NCAR Base NCAR Base DTC Project reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project requestor: METplus Team METplus Development Team type: task An actionable item of work
Milestone

Comments

@jprestop
Copy link
Collaborator

jprestop commented Mar 9, 2021

Describe the Task

Once ReadTheDocs is set up for all METplus components, set up gh-pages redirections, add documentation about ReadTheDocs, and remove or modify the "Update the Documentation on the Web" instructions in the Release Guide.

Time Estimate

Estimate the amount of work required here.
Issues should represent approximately 1 to 3 days of work.
< 1 day of work

Sub-Issues

Consider breaking the task down into sub-issues.

  • Add a checkbox for each sub-issue here.

Relevant Deadlines

ASAP

Funding Source

Split

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

  • Review projects and select relevant Repository and Organization ones or add "alert:NEED PROJECT ASSIGNMENT" label
  • Select milestone to next major version milestone 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), Project(s), Milestone, and Linked issues
  • 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 priority: high High Priority type: task An actionable item of work requestor: METplus Team METplus Development Team labels Mar 9, 2021
@jprestop jprestop added this to the METplus-4.0.0 milestone Mar 9, 2021
@jprestop jprestop self-assigned this Mar 9, 2021
@jprestop
Copy link
Collaborator Author

jprestop commented Mar 9, 2021

We will need to tag official releases with "stable" for them to show up as the latest "stable" branch. I will modify the Release Guide instructions to indicate that step.

@jprestop
Copy link
Collaborator Author

jprestop commented Apr 7, 2021

Work is complete.

@jprestop jprestop closed this as completed Apr 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Documentation issue priority: high High Priority reporting: DTC NCAR Base NCAR Base DTC Project reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project requestor: METplus Team METplus Development Team type: task An actionable item of work
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants