Skip to content

Transition the METplus Tutorial from Drupal to RTD #69

@jprestop

Description

@jprestop

Describe the Task

Our subteam met on April 3, 2025 to discuss transitioning the METplus 5.0 Tutorial to RTD.

The online tutorials currently live in Drupal here. We want to move the 5.0 Tutorial as-is, with modifications only for necessary RTD formatting.

@jprestop will come up with a plan for the METplus Tutorial front page in RTD. @lisagoodrich will transition the content. @j-opatz will then review the content and create an issue for transitioning v5.0 → v6.1 (keeping into current functionality).

Use the following for example formatting if desired:
ufs-srweather-app: RTD documentation, Corresponding GitHub location for formatting (need to click on "Raw" when selecting a specific rst file to see raw formatting)
There is an admonitions page with more options.

Remember to update this information in conf.py after we decided on a version:

version = '3.1'
release = f'{version}'
release_year = '2020'
release_date = f'{release_year}0810'

Time Estimate

See "discuss transitioning" link above

Sub-Issues

Consider breaking the task down into sub-issues.

  • Add a checkbox for each sub-issue here.

Relevant Deadlines

6.1.0 coordinated release

Funding Source

2702701 NCAR Base

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

  • Select Repository and/or Organization level Project(s) or add alert: NEED CYCLE ASSIGNMENT label
  • Select Milestone as the next official version or Future Versions

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.
  • 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 Linked issues
    Select: Repository level development cycle Project for the next official release
    Select: Milestone as the next official version
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.

Metadata

Metadata

Assignees

Type

Projects

Status

🛑 Not Ready

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions