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

Consider the use of subprojects in Read The Docs #2771

Open
8 of 24 tasks
jprestop opened this issue Nov 5, 2024 · 0 comments
Open
8 of 24 tasks

Consider the use of subprojects in Read The Docs #2771

jprestop opened this issue Nov 5, 2024 · 0 comments
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 type: task An actionable item of work
Milestone

Comments

@jprestop
Copy link
Collaborator

jprestop commented Nov 5, 2024

Describe the Task

In the 20241105 METplus Engineering Meeting, we discussed whether or not we should make each METplus component a subproject of METplus in ReadTheDocs. e.g. https://met.readthedocs.io/ becomes https://metplus.readthedocs.io/projects/met (but https://met.readthedocs.io/ still exists, it just redirects to the other site).

Searches on the parent project are supposed to include results from its subprojects, however in a quick search for MET via METplus, that did not seem to be the case. Further test this functionality.

@georgemccabe mentioned if we proceed with using subprojects, it would be good to include links in the table of contents to the other METplus components documentation, if possible. We don't want the documentation to be overwhelming for the user and may need to be more streamlined (include @j-opatz in this conversation as he has the greatest knowledge of feedback from users and the focus group).

It was noted that team members were too busy with the upcoming release to be able to give it the required attention. We decided to remove MET as a subproject of METplus for now and reconsider with the next release.

Time Estimate

??

Sub-Issues

Consider breaking the task down into sub-issues.

  • Add a checkbox for each sub-issue here.

Relevant Deadlines

By the official METplus 6.1.0 coordinated release

Funding Source

TBD

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.

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 type: task An actionable item of work 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 labels Nov 5, 2024
@jprestop jprestop added this to the METplus-6.1.0 milestone Nov 5, 2024
@jprestop jprestop self-assigned this Nov 5, 2024
@jprestop jprestop added component: documentation Documentation issue priority: medium Medium Priority requestor: METplus Team METplus Development Team labels Nov 5, 2024
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 type: task An actionable item of work
Projects
Status: 🩺 Needs Triage
Development

No branches or pull requests

1 participant