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.

Sign up for GitHub

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

Jump to bottom

Documentation Updates #1455

Closed
13 of 24 tasks
jprestop opened this issue Aug 12, 2020 · 3 comments · Fixed by #1485, #1585 or #1595
Closed
13 of 24 tasks

Documentation Updates #1455

jprestop opened this issue Aug 12, 2020 · 3 comments · Fixed by #1485, #1585 or #1595
Assignees
@jprestop @lisagoodrich
Labels
component: documentation Documentation issue priority: medium Medium Priority reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project requestor: NCAR/RAL NCAR Research Applications Laboratory type: task An actionable item of work
Milestone
MET 10.0.0

Comments

@jprestop
Copy link
Collaborator

jprestop commented Aug 12, 2020 •
edited
Loading

Describe the Task

Clean up the documentation

PDF/Web Documentation Comparison Chapter Sign Up Sheet - Things for the next version

Time Estimate

1 to 3 days of work for each sub task

Sub-Issues

Consider breaking the task down into sub-issues.

  • Correct spelling errors
  • Hanging indents for references
  • Make bolding consistent
  • Make references to Appendices consistent
  • Make references to external web pages consistent
  • Move README and README_TC contents to Sphinx

Relevant Deadlines

Next MET release

Funding Source

?

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 and link the pull request to this issue.
    Pull request: feature <Issue Number> <Description>
  • 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: NCAR/RAL NCAR Research Applications Laboratory labels Aug 12, 2020
@jprestop jprestop added this to the MET 10.0 milestone Aug 12, 2020
This was referenced Aug 12, 2020
Closed
Closed
Closed
Closed
Closed
@jprestop jprestop mentioned this issue Aug 25, 2020
Closed
7 tasks
@jprestop jprestop added the alert: NEED ACCOUNT KEY Need to assign an account key to this issue label Aug 25, 2020
@JohnHalleyGotway JohnHalleyGotway linked a pull request Sep 9, 2020 that will close this issue
Task 1455 doc #1485
Merged
@JohnHalleyGotway JohnHalleyGotway added the alert: NEED CYCLE ASSIGNMENT Need to assign to a release development cycle label Sep 10, 2020
@jprestop jprestop removed the alert: NEED CYCLE ASSIGNMENT Need to assign to a release development cycle label Sep 16, 2020
@JohnHalleyGotway
Copy link
Collaborator

JohnHalleyGotway commented Nov 6, 2020 •
edited
Loading

Julie, FYI, PR #1474 broke the Docker build. Here's the log:
https://hub.docker.com/repository/registry-1.docker.io/dtcenter/met/builds/f24be0ea-b738-4826-b862-e869484cf9c9

Compiling MET develop and writing log file /met/MET-develop/make_install.log
�[91mmake[2]: *** No rule to make target `README', needed by `all-am'. Stop.
�[0m�[91mmake[1]: *** [install-recursive] Error 1
�[0m�[91mmake: *** [install-recursive] Error 1

Please take a look in met/data/config/Makefile.am
Try removing references to README since that's gone. When "README_TC" goes away, we'll need to remove that from Makefile.am as well.

@lisagoodrich lisagoodrich linked a pull request Nov 30, 2020 that will close this issue
Task 1455 doc #1585
Merged
7 tasks
@jprestop
Copy link
Collaborator Author

This issue is nearing completion. Current things to be completed are consistent bolding of config arguments to the various tools and consistent italicizing of directories.

@lisagoodrich lisagoodrich linked a pull request Dec 3, 2020 that will close this issue
Task_1455_doc #1595
Merged
8 tasks
@jprestop
Copy link
Collaborator Author

jprestop commented Dec 4, 2020

Final pull request was approved and merged. Closing issue.

@jprestop jprestop closed this as completed Dec 4, 2020
@TaraJensen TaraJensen removed the alert: NEED ACCOUNT KEY Need to assign an account key to this issue label Dec 15, 2020
@TaraJensen TaraJensen added the reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project label Dec 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jprestop jprestop

@lisagoodrich lisagoodrich

Labels
component: documentation Documentation issue priority: medium Medium Priority reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project requestor: NCAR/RAL NCAR Research Applications Laboratory type: task An actionable item of work
Projects
None yet
Milestone
MET 10.0.0
Development

Successfully merging a pull request may close this issue.

Task 1455 doc dtcenter/MET
Task 1455 doc dtcenter/MET
Task_1455_doc dtcenter/MET
4 participants
@jprestop @JohnHalleyGotway @TaraJensen @lisagoodrich