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

Enhance the Release Notes by adding dropdown menus #2146

Closed
6 of 21 tasks
jprestop opened this issue Apr 27, 2022 · 2 comments · Fixed by #2459
Closed
6 of 21 tasks

Enhance the Release Notes by adding dropdown menus #2146

jprestop opened this issue Apr 27, 2022 · 2 comments · Fixed by #2459
Assignees
Labels
component: documentation Documentation issue priority: low Low Priority requestor: METplus Team METplus Development Team type: enhancement Improve something that it is currently doing
Milestone

Comments

@jprestop
Copy link
Collaborator

jprestop commented Apr 27, 2022

Please use Sphinx Design for Dropdown menus . This will allow for searches of material hidden within dropdown menus.

Changes will need to be made to the below files:

  1. config.py
    add 'sphinx_design' to the "extensions =" section. (note the underscore.)
  2. requirements.rst file.
    add 'sphinx-design==0.3.0' with a dash
  3. MET/.github/workflows/documentation.yml
    add a line after this example line 28 . Make sure it is correctly indented.
    python -m pip install -r docs/requirements.txt
  4. Remove 'sphinx-panels' from line28 in the code. This was originally added for dropdown menus. But the new version is 'sphinx-design'. It isn't needed. Removing it should avoid future confusion. sphinx-gallery Pillow sphinx_rtd_theme sphinx-panels

It should look like this:
python -m pip install --upgrade python-dateutil requests sphinx
sphinx-gallery Pillow sphinx_rtd_theme
python -m pip install -r docs/requirements.txt

Panel drop downs would be added for the subcategories and sub-subcategories. For example,
-Repository and build
---Installation
---Static Code Analysis
---Testing
---Continuous Integration
-Documentation
-Library code
---Bugfixes
---Python embedding enhancements
---Miscellaneous
---NetCDF Library
---Statistics computations
etc.

Note: One downside to using panels is that the content of the text contained in the panel will not show up in the search. However, I’m not sure the search functionality is particularly important for the Release Notes.

Time Estimate

Less than 1 day

Sub-Issues

Consider breaking the enhancement down into sub-issues.

  • Add a checkbox for each sub-issue here.

Relevant Deadlines

List relevant project deadlines here or state NONE.

Funding Source

Split between accounts 2702691 and 2792542

Define the Metadata

Assignee

  • Select engineer(s) or no engineer required Lisa Goodrich
  • 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.

Enhancement 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 Linked 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.
@jprestop jprestop added type: enhancement Improve something that it is currently doing component: documentation Documentation issue priority: low Low 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 Apr 27, 2022
@jprestop jprestop added this to the Consider for Next Release milestone Apr 27, 2022
@JohnHalleyGotway JohnHalleyGotway removed the alert: NEED CYCLE ASSIGNMENT Need to assign to a release development cycle label Apr 28, 2022
@jprestop jprestop modified the milestones: MET 11.0.0, MET 11.1.0 Dec 1, 2022
@jprestop jprestop moved this to 📋 Backlog in MET-11.1.0 Development Dec 1, 2022
@lisagoodrich lisagoodrich removed the alert: NEED ACCOUNT KEY Need to assign an account key to this issue label Feb 21, 2023
@lisagoodrich lisagoodrich changed the title Enhance the Release Notes by adding sphinx-panels Enhance the Release Notes by adding dropdown menus Feb 21, 2023
@jprestop jprestop removed the alert: NEED MORE DEFINITION Not yet actionable, additional definition required label Feb 21, 2023
@lisagoodrich lisagoodrich linked a pull request Feb 22, 2023 that will close this issue
15 tasks
@JohnHalleyGotway JohnHalleyGotway moved this from 📋 Backlog to ✅ Done in MET-11.1.0 Development Feb 28, 2023
@jprestop
Copy link
Collaborator Author

jprestop commented Mar 7, 2023

@lisagoodrich and I are reopening this issue because we have one more step that needs to be completed. The build on ReadTheDocs is working fine, but the build in GitHub Actions is not. The GHA run appeared to be successful, but was actually not successful. We are already aware of this problem and it will be fixed with the issue Bugfix: Check the return status of the "make clean html" command in build_documentation.sh #2436.

The following needs to be added to this issue:

MET/.github/workflows/documentation.yml
add a line after these lines 27 and 28. Make sure it is correctly indented.

python -m pip install -r docs/requirements.txt

It should look like this:

          python -m pip install --upgrade python-dateutil requests sphinx \
          sphinx-gallery Pillow sphinx_rtd_theme sphinx-panels
          python -m pip install -r docs/requirements.txt

@jprestop jprestop reopened this Mar 7, 2023
@github-project-automation github-project-automation bot moved this from ✅ Done to 🏗 In progress in MET-11.1.0 Development Mar 7, 2023
@lisagoodrich
Copy link
Contributor

I have updated the issue information with the steps needed to make sure the dropdown menus run correctly.

@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in MET-11.1.0 Development Mar 8, 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: low Low Priority requestor: METplus Team METplus Development Team type: enhancement Improve something that it is currently doing
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants