NCAR / NCAR/HPC-Docs

Stable gets badly out of date

Open
#367 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
HTML
Stars
13
Forks
26
Avg merge
3d 18h
Merged PRs (30d)
4

Description

It looks like the "stable" version of the docs is being used by some in the community, even though we link to "latest" and I think that is the default.

The workflow seems to be that a new tag/release needs to be created, and then the next time a PR triggers a doc rebuild, stable will use the contents of that release. Probably having something automated to create a new stable each month (maybe only if there have been commits in that month) would be best, as "stable" was extremely stale (2024) before I created a new tag today.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by examining the workflow that creates tags or releases and the PR-triggered documentation rebuild mentioned in the issue. Determine how the stable version is selected and how to schedule a monthly update only when the month contains commits. Done means stable is refreshed automatically without requiring a manual tag.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation, release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.