Uploaded image for project: 'OPCT - OpenShift Provider Compatibility Tool'
  1. OPCT - OpenShift Provider Compatibility Tool
  2. OPCT-251

[docs] Create versioned documentation

XMLWordPrintable

    • Icon: Epic Epic
    • Resolution: Unresolved
    • Icon: Undefined Undefined
    • None
    • None
    • Documentation
    • [docs] Create versioned documentation
    • False
    • Hide

      None

      Show
      None
    • False
    • To Do

      Goal:

      • Research if it is possible to create the versioning for OPCT documentation

      Motivation:

      The OPCT documentation is build upon the 'main' branch, so for each approved PR tha new documentation will be created, regardless the project tag/release.

      That strategy is good as we can move and quickly fix documentation fragments without needing to create release for the project, although for users could be confusing when the 'always latest' documentation could point to one OPCT CLI version that is not created, or not globally available (for example renaming the CLI to 'opct', removing certificatoin from the name OPCT-217).

      It could block some tasks  like OPCT-217, or could cause confusion to the users.

      There are one utility commonly used by projects which uses mkdocs framework called 'mike'[1], it creates static versioned content under Github Pages (branch gh-pages), allowing to keep the released versions with unchanged doc, pointing old OPCT releases to those docs, allowing the project to move on in the 'latest' documentation. Example of project using this versioned content[2].

      Setting up this kind of documentations could provide a benefit for the user and developers moving documentation without touching in versioned content.

       

      References:

      [1] https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/ 

      https://github.com/jimporter/mike

      [2] https://kubernetes-sigs.github.io/aws-load-balancer-controller/v2.6/

      https://github.com/kubernetes-sigs/aws-load-balancer-controller/blob/main/Makefile#L162-L168

       

            Unassigned Unassigned
            rhn-support-mrbraga Marco Braga
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: