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: Update the Code Support section of the User's Guides #2857

Open
8 of 23 tasks
jprestop opened this issue Jan 9, 2025 · 1 comment
Open
8 of 23 tasks
Assignees
Labels
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 component: documentation Documentation issue priority: medium Medium Priority requestor: METplus Team METplus Development Team
Milestone

Comments

@jprestop
Copy link
Collaborator

jprestop commented Jan 9, 2025

Describe the Task

The lack of ability to continue to use the FTP server for uploading user data for Discussions and discussion at the METplus Advisory Group meeting led us to want to clarify where and how we references METplus Discussions as a tool for discussion and user support for all of the METplus components.

Rename the Code Support section of the Overview chapter in the METplus User's Guide and rewrite it to structure it so that it conveys that Discussions is a tool for discussion and user support for all of the METplus components.

Note that the Overview chapter in the other User's Guides also have sections on Code Support (MET, METdataio, METviewer) except for METcalcpy and METplotpy which do not have an Overview chapter at all.

Note that John HG modified the Code Support section for MET which may now be User Support.

Determine if the information from these sections:

  • is important and needs to remain in the individual User's Guides
  • is redundant and should not be repeated, being combined into METplus and linked to from the individual User's Guides

Also, create a METcalcpy and METplotpy Overview page (create issues for that work in those repos when ready?) for consistency with the other components.

Time Estimate

1-3 days of work

Sub-Issues

Consider breaking the task down into sub-issues.

  • Add a checkbox for each sub-issue here.

Relevant Deadlines

None

Funding Source

TBD

Define the Metadata

Assignee

  • Select appropriate assignee for this issue

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.

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.
  • 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.
@jprestop jprestop added component: documentation Documentation issue priority: medium Medium Priority 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 Jan 9, 2025
@jprestop jprestop added this to the METplus-6.1.0 milestone Jan 9, 2025
@jprestop jprestop self-assigned this Jan 9, 2025
@jprestop jprestop moved this from 🩺 Needs Triage to 🟢 Ready in METplus-Wrappers-6.1.0 Development Jan 9, 2025
@jprestop jprestop moved this from 🟢 Ready to 🩺 Needs Triage in METplus-Wrappers-6.1.0 Development Jan 9, 2025
@JohnHalleyGotway
Copy link
Collaborator

JohnHalleyGotway commented Jan 9, 2025

Renamed the "Code support" section of the "Overview" chapter as "User support" in the develop branch, as discussed at the METplus-Analysis tools meeting on 1/9/2025:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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 component: documentation Documentation issue priority: medium Medium Priority requestor: METplus Team METplus Development Team
Projects
Status: 🩺 Needs Triage
Development

No branches or pull requests

2 participants