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

Create dropdown menus for Appendix A #2460

Closed
7 of 21 tasks
lisagoodrich opened this issue Feb 22, 2023 · 2 comments · Fixed by #2501
Closed
7 of 21 tasks

Create dropdown menus for Appendix A #2460

lisagoodrich opened this issue Feb 22, 2023 · 2 comments · Fixed by #2501
Assignees
Labels
component: documentation Documentation issue priority: medium Medium Priority requestor: METplus Team METplus Development Team type: task An actionable item of work
Milestone

Comments

@lisagoodrich
Copy link
Contributor

lisagoodrich commented Feb 22, 2023

Replace italics below with details for this issue.

Describe the Task

Sphinx Design for Dropdown menus is a new way of creating dropdown menus. These menus are searchable using ctrl - f or the search function in READTHEDOCS. The old version (sphinx-panels) wasn't searchable. In order to maintain consistency and for ease of documentation viewing, change the questions and answers in Appendix A to dropdown menus.

In order to be able to link to the questions, they will need to stay as sections. Every dropdown menu should be labeled "Answer". The answer documentation will be in the dropdown menu. The question will be viewable as a section header.

Please note that changes have already been made to the config.py and the requirements.rst file. sphinx_design with an underscore needed to be added to the config.py file. And sphinx-design with a dash needed to be added to the requirements.rst file. If this is going to be done on other METplus products, this may need to be added to work.

Time Estimate

Estimate the amount of work required here.
1 to 2 days of work.

Sub-Issues

Consider breaking the task down into sub-issues.

  • Add a checkbox for each sub-issue here.

Relevant Deadlines

List relevant project deadlines here or state NONE.
There is no hard deadline for this

Funding Source

2792541

Define the Metadata

None

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 PROJECT ASSIGNMENT label
  • Select Milestone as the next official version or Future Versions

Define Related Issue(s)

Consider the impact to the other METplus components. NO IMPACT

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) and Development issues
    Select: Repository level development cycle Project for the next official release
    Select: Milestone as the next official version
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.
@lisagoodrich lisagoodrich added component: documentation Documentation issue type: task An actionable item of work priority: medium Medium Priority alert: NEED MORE DEFINITION Not yet actionable, additional definition required alert: NEED ACCOUNT KEY Need to assign an account key to this issue alert: NEED CYCLE ASSIGNMENT Need to assign to a release development cycle requestor: METplus Team METplus Development Team labels Feb 22, 2023
@lisagoodrich lisagoodrich added this to the MET 11.1.0 milestone Feb 22, 2023
@lisagoodrich lisagoodrich self-assigned this Feb 22, 2023
@jprestop jprestop removed alert: NEED MORE DEFINITION Not yet actionable, additional definition required alert: NEED CYCLE ASSIGNMENT Need to assign to a release development cycle labels Feb 22, 2023
@jprestop jprestop moved this from 📋 Backlog to 🔖 Ready in MET-11.1.0 Development Feb 22, 2023
@lisagoodrich
Copy link
Contributor Author

This was not part of the task but once I changed the indentation to accommodate the dropdown menus, this threw off the line spacing. Some lines went over the 79 characters per line. I made sure the new spacing is under 79 characters per line. Exceptions to this include, code blocks, web addresses or headers.

@lisagoodrich lisagoodrich removed the alert: NEED ACCOUNT KEY Need to assign an account key to this issue label Mar 31, 2023
@lisagoodrich lisagoodrich linked a pull request Mar 31, 2023 that will close this issue
15 tasks
@lisagoodrich
Copy link
Contributor Author

Work has been completed.

@github-project-automation github-project-automation bot moved this from 🔖 Ready to ✅ Done in MET-11.1.0 Development Apr 3, 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: task An actionable item of work
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants