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

Tidy up glossary errors in documentation #844

Closed
21 tasks
DanielAdriaansen opened this issue Mar 17, 2021 · 3 comments · Fixed by #845
Closed
21 tasks

Tidy up glossary errors in documentation #844

DanielAdriaansen opened this issue Mar 17, 2021 · 3 comments · Fixed by #845
Assignees
Labels
component: documentation Documentation issue reporting: DTC NCAR Base NCAR Base DTC Project reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project type: bug Fix something that is not working
Milestone

Comments

@DanielAdriaansen
Copy link
Contributor

Describe the Problem

There were some glossary warnings when building the documentation from #768 that were allowed through the PR for #837 to get the features implemented in develop for others to complete their work for the release. I failed to follow up on these warnings, and this issue is to fix the remaining errors.

Expected Behavior

No glossary warnings when building docs.

Environment

Describe your runtime environment:
1. Machine: (e.g. HPC name, Linux Workstation, Mac Laptop)
2. OS: (e.g. RedHat Linux, MacOS)
3. Software version number(s)

To Reproduce

Describe the steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
Post relevant sample data following these instructions:
https://dtcenter.org/community-code/model-evaluation-tools-met/met-help-desk#ftp

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

  • Review projects and select relevant Repository and Organization ones or add "alert:NEED PROJECT ASSIGNMENT" label
  • Select milestone to relevant bugfix version

Define Related Issue(s)

Consider the impact to the other METplus components.

Bugfix 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 main_<Version>.
    Branch name: bugfix_<Issue Number>_main_<Version>_<Description>
  • Fix the bug 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 main_<Version>.
    Pull request: bugfix <Issue Number> main_<Version> <Description>
  • Define the pull request metadata, as permissions allow.
    Select: Reviewer(s), Project(s), Milestone, and Linked issues
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Complete the steps above to fix the bug on the develop branch.
    Branch name: bugfix_<Issue Number>_develop_<Description>
    Pull request: bugfix <Issue Number> develop <Description>
  • Close this issue.
@DanielAdriaansen DanielAdriaansen added the type: bug Fix something that is not working label Mar 17, 2021
@DanielAdriaansen DanielAdriaansen self-assigned this Mar 17, 2021
@DanielAdriaansen DanielAdriaansen added the component: documentation Documentation issue label Mar 17, 2021
@DanielAdriaansen DanielAdriaansen added this to To do in METplus-4.0.0-rc1 (5/4/21) via automation Mar 17, 2021
@DanielAdriaansen DanielAdriaansen added this to the METplus-4.0.0 milestone Mar 17, 2021
@DanielAdriaansen DanielAdriaansen linked a pull request Apr 4, 2021 that will close this issue
10 tasks
@DanielAdriaansen
Copy link
Contributor Author

DanielAdriaansen commented Apr 4, 2021

This was resolved by #845 but somehow the PR didn't automatically close the issue.

METplus-4.0.0-rc1 (5/4/21) automation moved this from To do to Done Apr 4, 2021
@georgemccabe
Copy link
Collaborator

@DanielAdriaansen for future reference, linked an issue to a pull request will not automatically close it. You will need to put a keyword in front of the name of the issue in the pull request comment that tells it to close the issue, i.e. closes #844

@DanielAdriaansen
Copy link
Contributor Author

Yeah I had "closes # 844" in the issue description, but maybe I need it in the PR comment or something like you mentioned. Either way, I just wanted to close this and clean it up.

@TaraJensen TaraJensen added reporting: DTC NCAR Base NCAR Base DTC Project reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project labels May 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Documentation issue reporting: DTC NCAR Base NCAR Base DTC Project reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project type: bug Fix something that is not working
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

3 participants