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

Documentation: Include information on how to use command line arguments to override single config variables #2814

Closed
1 of 24 tasks
georgemccabe opened this issue Dec 6, 2024 · 0 comments · Fixed by #2825 or #2826
Closed
1 of 24 tasks
Assignees
Labels
component: documentation Documentation issue reporting: NRL METplus Naval Research Laboratory METplus Project requestor: METplus Team METplus Development Team
Milestone

Comments

@georgemccabe
Copy link
Collaborator

georgemccabe commented Dec 6, 2024

Describe the Enhancement

This information should be more clearly present towards to top of the Configuration chapter.

Time Estimate

< 4 hours

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

NRL 7730022

Define the Metadata

Assignee

  • Select engineer(s) or no engineer required
  • Select scientist(s) or no scientist required

Labels

  • Review default alert labels
  • Select component(s)
  • Select priority
  • Select requestor(s)

Milestone and Projects

  • Select Milestone as a METplus-Wrappers-X.Y.Z version, Consider for Next Release, or Backlog of Development Ideas
  • For a METplus-Wrappers-X.Y.Z version, select the METplus-Wrappers-X.Y.Z Development project

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.
  • Add any new Python packages to the METplus Components Python Requirements table.
  • For any new datasets, an entry to the METplus Verification Datasets Guide.
  • 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 issue
    Select: Milestone as the next official version
    Select: METplus-Wrappers-X.Y.Z Development project for development toward the next official release
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.
@georgemccabe georgemccabe added component: documentation Documentation issue requestor: METplus Team METplus Development Team reporting: NRL METplus Naval Research Laboratory METplus Project labels Dec 6, 2024
@georgemccabe georgemccabe added this to the METplus-6.0.0 milestone Dec 6, 2024
@georgemccabe georgemccabe self-assigned this Dec 6, 2024
@georgemccabe georgemccabe moved this from 🩺 Needs Triage to 🟢 Ready in METplus-Wrappers-6.0.0 Development Dec 6, 2024
@georgemccabe georgemccabe moved this from 🩺 Needs Triage to 🟢 Ready in METplus-Wrappers-6.1.0 Development Dec 6, 2024
@georgemccabe georgemccabe moved this from 🟢 Ready to 🏗 In progress in METplus-Wrappers-6.0.0 Development Dec 10, 2024
@georgemccabe georgemccabe moved this from 🟢 Ready to 🏗 In progress in METplus-Wrappers-6.1.0 Development Dec 10, 2024
georgemccabe added a commit that referenced this issue Dec 11, 2024
georgemccabe added a commit that referenced this issue Dec 11, 2024
@georgemccabe georgemccabe moved this from 🏗 In progress to 🔎 In review in METplus-Wrappers-6.0.0 Development Dec 11, 2024
@georgemccabe georgemccabe moved this from 🏗 In progress to 🔎 In review in METplus-Wrappers-6.1.0 Development Dec 11, 2024
georgemccabe added a commit that referenced this issue Dec 16, 2024
* per #2814, add documentation to describe how to set a single config variable on the command line

* fixed typos and formatting issues

* move new content to top of chapter and reword intro sentence

* change label and add link to user env var section

* per #2814, added info and examples for single config overrides with a list of values
georgemccabe added a commit that referenced this issue Dec 16, 2024
* per #2814, add documentation to describe how to set a single config variable on the command line

* fixed typos and formatting issues

* move new content to top of chapter and reword intro sentence

* change label and add link to user env var section
@github-project-automation github-project-automation bot moved this from 🔎 In review to 🏁 Done in METplus-Wrappers-6.1.0 Development Dec 16, 2024
@github-project-automation github-project-automation bot moved this from 🔎 In review to 🏁 Done in METplus-Wrappers-6.0.0 Development Dec 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Documentation issue reporting: NRL METplus Naval Research Laboratory METplus Project requestor: METplus Team METplus Development Team
Projects
Status: 🏁 Done
Status: 🏁 Done
1 participant