Uploaded image for project: 'CDAP'
  1. CDAP
  2. CDAP-2539

Add a build identifier (branch, commit) to Documentation HTML pages

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 3.0.0
    • Fix Version/s: 3.1.0
    • Component/s: Docs
    • Labels:
    • Rank:
      1|hzytn3:

      Description

      Currently, when the documentation is built, it has a version number (2.6.3, 3.0.0) associated with it, but no other identifier. There's no way to tell if the HTML files you are looking at have been built from a particular branch, or a particular commit in that branch. Thus, you'd need to rebuild the docs to make sure you had the latest.

      This doesn't have to be visible to a user (it could be in the meta tags of the HTML files) but it would be good to know which branch and which commit a build of the documentation was generated from.

        Attachments

          Activity

            People

            • Assignee:
              John John Jackson
              Reporter:
              John John Jackson
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: