Uploaded image for project: 'Kudu'
  1. Kudu
  2. KUDU-2506

Improve and document docs push procedure

Agile BoardAttach filesAttach ScreenshotAdd voteVotersWatch issueWatchersCreate sub-taskLinkCloneUpdate Comment AuthorReplace String in CommentUpdate Comment VisibilityDelete Comments
    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: 1.7.1
    • Fix Version/s: None
    • Component/s: documentation
    • Labels:
      None

      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.

        Attachments

        Issue Links

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              mpercy Mike Percy

              Dates

              • Created:
                Updated:

                Issue deployment