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

Feature 2146 dropdown menus #2459

Merged
merged 8 commits into from
Feb 24, 2023
Merged

Conversation

lisagoodrich
Copy link
Contributor

@lisagoodrich lisagoodrich commented Feb 22, 2023

Expected Differences

  • Do these changes introduce new tools, command line arguments, or configuration file options? [No]

    If yes, please describe:

  • Do these changes modify the structure of existing or add new output data types (e.g. statistic line types or NetCDF variables)? [No]

    If yes, please describe:

Pull Request Testing

  • Describe testing already performed for these changes:
    I have created all of the dropdown menus, open and closed them.

  • Recommend testing for the reviewer(s) to perform, including the location of input datasets, and any additional instructions:
    Please test the dropdown menus by clicking on them in the feature branch before merging. https://met.readthedocs.io/en/feature_2146_dropdown_menus/Users_Guide/release-notes.html

  • Do these changes include sufficient documentation updates, ensuring that no errors or warnings exist in the build of the documentation? [Yes]

  • Do these changes include sufficient testing updates? [Yes]

  • Will this PR result in changes to the test suite? [No]

    If yes, describe the new output and/or changes to the existing output:

  • Please complete this pull request review by 2/28/23.
    I chose this date to get this change in with the beta1 release. The date can be changed.

Pull Request Checklist

See the METplus Workflow for details.

  • Review the source issue metadata (required labels, projects, and milestone).
  • Complete the PR definition above.
  • Ensure the PR title matches the feature or bugfix branch name.
  • Define the PR metadata, as permissions allow.
    Select: Reviewer(s)
    Select: Organization level software support Project or Repository level development cycle Project
    Select: Milestone as the version that will include these changes
  • After submitting the PR, select Development issue with the original issue number.
  • After the PR is approved, merge your changes. If permissions do not allow this, request that the reviewer do the merge.
  • Close the linked issue and delete your feature or bugfix branch from GitHub.

@lisagoodrich lisagoodrich added the component: documentation Documentation issue label Feb 22, 2023
@lisagoodrich lisagoodrich added this to the MET 11.0.1 (bugfix) milestone Feb 22, 2023
@lisagoodrich lisagoodrich linked an issue Feb 22, 2023 that may be closed by this pull request
21 tasks
Copy link
Contributor

@j-opatz j-opatz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The collapsible menus provide a much needed cleanup to the lengthy release notes for each Beta and official release.
The discussion made during a MET engineering meeting on the bugfix releases is still a valid concern: all of the issues would fall under a single accordion, which only perpetuates the "out of sight, out of mind" fix that doesn't fix anything at all.
As future bugfix, betas, and eventually official releases utilize this new menu layout, the METplus team needs to begin thinking about presentation of the issues in the layout to maximize usability and ease of reading. This may mean creating new top level categories, subcategories, bold font choices, or even different templates for what type of release it is. Feedback from the focus group will help, but innovative ideas can also come from within the team (as evident in the creation of this layout).
The PR does what it set out to do, and is approved.

@jprestop jprestop removed their request for review February 24, 2023 20:58
@lisagoodrich lisagoodrich merged commit 9b6c6de into develop Feb 24, 2023
@lisagoodrich lisagoodrich deleted the feature_2146_dropdown_menus branch February 24, 2023 22:12
@JohnHalleyGotway JohnHalleyGotway removed the component: documentation Documentation issue label Feb 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Enhance the Release Notes by adding dropdown menus
4 participants