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

Documentation: Make Headers Consistent in All MET Guides #2716

Closed
7 of 8 tasks
lisagoodrich opened this issue Oct 16, 2023 · 0 comments · Fixed by #2725
Closed
7 of 8 tasks

Documentation: Make Headers Consistent in All MET Guides #2716

lisagoodrich opened this issue Oct 16, 2023 · 0 comments · Fixed by #2725
Assignees
Labels
component: documentation Documentation issue priority: medium Medium Priority requestor: METplus Team METplus Development Team type: sub-issue Break an issue down into smaller parts
Milestone

Comments

@lisagoodrich
Copy link
Contributor

This is a sub-issue of #898.
dtcenter/METplus#898

Describe the Sub-Issue

This task is for all METplus component. This specific issue is for MET only:

The headers for the MET components User's Guides may not be consistent, but we want them to be.

Here is the syntax from the RST docs (https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections):

# with overline, for parts (e.g. the RTD documentation for the component (i.e. docs/index.rst), each guide (e.g. User's Guide, Contributor's Guide) (i.e. docs/Users_Guide/index.rst, docs/Contributors_Guide/index.rst))
* with overline, for chapters
=, for sections
-, for subsections
^, for subsubsections
", for paragraphs

Time Estimate

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

Define the Metadata

Assignee

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

Labels

  • Review default alert labels
  • Select component(s)
  • Select priority
  • Select requestor(s)

Milestone and Projects

  • Select Milestone as the next official version or Backlog of Development Ideas
  • For the next official version, select the MET-X.Y.Z Development project

Funding Source

2783543 - Lisa has hours on this account.

@lisagoodrich lisagoodrich added component: documentation Documentation issue priority: medium Medium Priority type: sub-issue Break an issue down into smaller parts requestor: METplus Team METplus Development Team labels Oct 16, 2023
@lisagoodrich lisagoodrich added this to the MET 12.0.0 milestone Oct 16, 2023
@lisagoodrich lisagoodrich self-assigned this Oct 16, 2023
@lisagoodrich lisagoodrich linked a pull request Nov 6, 2023 that will close this issue
15 tasks
@jprestop jprestop closed this as completed Nov 9, 2023
@github-project-automation github-project-automation bot moved this from 🔖 Ready to ✅ Done in MET-12.0.0 Development Nov 9, 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 requestor: METplus Team METplus Development Team type: sub-issue Break an issue down into smaller parts
Projects
No open projects
Status: 🏁 Done
Development

Successfully merging a pull request may close this issue.

2 participants