[KUDU-2506] Improve and document docs push procedure

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Affects Version/s: 1.7.1
• Component/s: documentation
• Assignee: Unassigned
• Reporter: Mike Percy
• Created: 16/Jul/18 22:08
• Updated: 16/Jul/18 22:09

Description

As of this writing, when we want to push docs for a release, the release docs will overwrite the existing "unversioned" docs. This is a problem for maintenance releases, such as releasing a 1.5.1 after a 1.6.0 release, since the unversioned 1.6.0 docs living at http://kudu.apache.org/docs/ will be replaced with 1.5.1 docs.

We should improve this process and the scripts that drive it. Potential improvements:

• Add an option to the docs publish script to only update the versioned docs, i.e. --versioned-only
• Separate out master vs versioned docs push into separate script invocations
• Create a Jenkins job that can build and deploy docs to either /docs or a release docs location.

Issue Links

• relates to: KUDU-2505 Add menu for switching between docs versions to Kudu web site docs
• relates to: KUDU-2504 Add Kudu version number to header of docs pages