Project

General

Profile

Actions

Feature #15138

closed

Support building of documentation for each stable release

Added by Peter Amstutz over 5 years ago. Updated almost 5 years ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
-
Target version:
Story points:
2.0
Release relationship:
Auto

Description

We should support building multiple documentation versions (stable releases, master) and switching between them.

New jenkins job that takes a git ref (tag or 'master') and builds documentation for that version.

  1. git checkout target version
  2. build documentation
    1. parameter for target version, displayed on page header
    2. link to index page with all versions
  3. upload documentation to doc server at a target version directory
  4. regenerate index page with all versions + master
  5. upload index page
development tasks:
  • documentation lists selected version, dropdown menu links to every version
ops task:
  • jenkins job to generate documentation for target version (either as part of build pipeline or release process)

Subtasks 1 (0 open1 closed)

Task #15354: review 15138-version-our-documentationResolvedPeter Amstutz06/12/2019Actions
Actions

Also available in: Atom PDF