Consider the use of subprojects in Read The Docs #2771
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
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.
Relevant Deadlines
By the official METplus 6.1.0 coordinated release
Funding Source
TBD
Define the Metadata
Assignee
Labels
Milestone and Projects
Define Related Issue(s)
Consider the impact to the other METplus components.
Task Checklist
See the METplus Workflow for details.
Branch name:
feature_<Issue Number>_<Description>
Pull request:
feature <Issue Number> <Description>
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
The text was updated successfully, but these errors were encountered: