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 METviewer Guides #497

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

Documentation: Make Headers Consistent in All METviewer Guides #497

lisagoodrich opened this issue Oct 16, 2023 · 0 comments · Fixed by #502
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

Comments

@lisagoodrich
Copy link
Contributor

lisagoodrich commented Oct 16, 2023

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 METviewer only:

The headers for the METviewer 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.

Funding Source

2783543 - Lisa has hours on this account.

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 CYCLE ASSIGNMENT label
  • Select Milestone as the next official version or Future Versions
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
Status: 🟢 Ready
Development

Successfully merging a pull request may close this issue.

2 participants