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

Transition MET user's guide from lyx to sphinx. #1217

Closed
24 of 26 tasks
JohnHalleyGotway opened this issue Nov 21, 2019 · 2 comments
Closed
24 of 26 tasks

Transition MET user's guide from lyx to sphinx. #1217

JohnHalleyGotway opened this issue Nov 21, 2019 · 2 comments
Assignees
Labels
component: documentation Documentation issue priority: blocker Blocker requestor: NCAR/RAL NCAR Research Applications Laboratory type: task An actionable item of work
Milestone

Comments

@JohnHalleyGotway
Copy link
Collaborator

JohnHalleyGotway commented Nov 21, 2019

Describe the Task

Follow the same workflow for transitioning METplus and METviewer UGs to sphinx

Time Estimate

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

Sub-Issues

Consider breaking the task down into sub-issues.

  • Try using pandoc to see if any files can be automatically converted.
  • Create gh-pages branch
  • Create docs subdirectory
  • Create some template files to get Lisa started
  • Move basic content over to Sphinx by Monday and merge into develop
  • Incorporate recent changes from the transition Google doc and merge into develop.
  • Add references and titles to the MET Documentation
  • Publish the user's guide using gh-pages.

Relevant Deadlines

5/3 if possible but if not 5/20 (met-9.1-beta2)

Funding Source

2702691 - Dan (30hrs), Julie (60hrs), Lisa(60hrs)

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
  • Select milestone

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.
  • Fork this repository or create a branch of develop.
    Branch name: feature_<Issue Number>_<Description>
  • Complete the task and verify your changes.
  • Add/update unit tests.
  • Add/update documentation.
  • Push local changes to GitHub.
  • Submit a pull request to merge into develop, listing the <Issue Number> in the title.
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.
@JohnHalleyGotway JohnHalleyGotway added component: documentation Documentation issue type: task An actionable item of work priority: medium Medium Priority requestor: NCAR/RAL NCAR Research Applications Laboratory labels Nov 21, 2019
@JohnHalleyGotway JohnHalleyGotway added this to the MET 9.1 milestone Nov 21, 2019
@JohnHalleyGotway JohnHalleyGotway added this to To do in MET-9.1-beta1 (4/29/20) via automation Mar 23, 2020
@TaraJensen TaraJensen added priority: high and removed priority: medium Medium Priority labels Apr 2, 2020
@jprestop jprestop moved this from To do to In progress in MET-9.1-beta1 (4/29/20) Apr 6, 2020
@JohnHalleyGotway JohnHalleyGotway removed this from In progress in MET-9.1-beta1 (4/29/20) Apr 28, 2020
@JohnHalleyGotway JohnHalleyGotway added this to To do in MET-9.1-beta2 (7/14/20) via automation Apr 28, 2020
@lisagoodrich
Copy link
Contributor

Moved basic content over to Sphinx by Monday and merged into develop (DONE 4/21/20 Lisa Goodrich)

@JohnHalleyGotway JohnHalleyGotway added this to To do in MET-9.1-beta4 (8/10/20) via automation Jul 30, 2020
@JohnHalleyGotway JohnHalleyGotway moved this from To do to In progress in MET-9.1-beta4 (8/10/20) Jul 30, 2020
@jprestop jprestop moved this from In progress to Pull request review in MET-9.1-beta4 (8/10/20) Jul 31, 2020
@jprestop
Copy link
Collaborator

This work is complete.

MET-9.1-beta4 (8/10/20) automation moved this from Pull request review to Done Jul 31, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Documentation issue priority: blocker Blocker requestor: NCAR/RAL NCAR Research Applications Laboratory type: task An actionable item of work
Projects
No open projects
Development

No branches or pull requests

5 participants