dtcenter/METplotpy

Create pull-down in User Guide configuration file

Opened this issue · 5 comments

bikegeek commented

Replace italics below with details for this issue.

Describe the Task

Users are overwhelmed with what the settings in the configuration file do. The configuration files are long and adding additional content following the config files makes it inconvenient for users to navigate the User's Guide. Providing pull down menus corresponding to salient settings in the config file will make navigation easier for users.

Time Estimate

Estimate the amount of work required here.
Issues should represent approximately 1 to 3 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.

Funding Source

Define the source of funding and account keys here or state NONE.

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

Define Related Issue(s)

Consider the impact to the other METplus components.

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.
  • Add any new Python packages to the METplus Components Python Requirements table.
  • 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 commented

@bikegeek I've got a couple questions about this.

  1. Do you want me to add dropdown menus for ALL of the documentation in the METplotpy User's Guide? https://metplotpy.readthedocs.io/en/latest/Users_Guide/histogram.html
  2. Or is it just for the longer chapters?
  3. It says to consider the implications to the other MET products. I'm not sure what this means. Am I supposed to do dropdown menus for all the different MET products?
    Let me know if it's easier to have a conversation about this instead.
bikegeek commented
lisagoodrich commented

Hi @bikegeek,

@TaraJensen has given the okay for me to start working on things. I thought this might be an easy place to start. Do you have time to discuss this with me or should I move onto another task?

bikegeek commented
lisagoodrich commented

No problem. Thanks for letting me know.