Consider readthedocs style handling of multiple versions

Open
#1,373 5 comments 22 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
javascript, r
Domain
documentation, release

Research direction

Start by reviewing the current documentation build process and default template, then compare it with the versioning requirements listed in the issue. Done means supporting tagged versions under /version/..., local builds, a central version list, version switching, and the proposed search-indexing and outdated-version behaviors.

Written by the indexing model from the issue text.

Description

deploy :airplane: feature

(with a few tweaks for our needs)

  • Latest continues to live in top-level directory
  • Tagged releases built in /version/... (also need to be able to run locally in case automation fails or otherwise needs update)
  • Need to somehow record all versions in central location
  • Default template gets javascript popup for switching versions
  • Need to consider no-index or canonical strategy to ensure that google doesn't find old version of docs.
  • Optional javascript that displays "this isn't the latest version" banner somewhere on page
Dominant language
R
Stars
775
Forks
355
No merged PRs in 30d

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.

More from r-lib/pkgdown

All issues in r-lib/pkgdown

Similar issues

More R issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.