Feature #15138

Support building of documentation for each stable release

Added by Peter Amstutz 27 days ago. Updated 20 days ago.

Status:
New
Priority:
Normal
Assigned To:
-
Category:
-
Target version:
Start date:
Due date:
% Done:

0%

Estimated time:
Story points:
2.0

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)

History

#1 Updated by Peter Amstutz 27 days ago

  • Status changed from New to In Progress

#2 Updated by Peter Amstutz 27 days ago

  • Subject changed from Containerize documentation building to Containerize documentation building & support multiple versions
  • Status changed from In Progress to New

#3 Updated by Peter Amstutz 27 days ago

  • Description updated (diff)

#4 Updated by Tom Morris 20 days ago

  • Subject changed from Containerize documentation building & support multiple versions to Support building of documentation for each stable release
  • Description updated (diff)

#5 Updated by Peter Amstutz 20 days ago

  • Description updated (diff)

#6 Updated by Peter Amstutz 20 days ago

  • Description updated (diff)

#7 Updated by Peter Amstutz 20 days ago

  • Description updated (diff)

#8 Updated by Peter Amstutz 20 days ago

  • Target version changed from To Be Groomed to Arvados Future Sprints
  • Story points set to 2.0

Also available in: Atom PDF