Uploaded image for project: 'OpenShift GitOps'
  1. OpenShift GitOps
  2. GITOPS-1511

Publish GitOps User Document to GitHub

XMLWordPrintable

    • Publish GitOps User Document to GitHub
    • False
    • False
    • To Do
    • 0% To Do, 0% In Progress, 100% Done

      Why

      The dev team maintains a well written usage guide to include up-to-date features.  However, it is limited to internal use.   There is a good amount of delay before features can be documented in official OpenShift docs.   SAs and customers are having difficult time to use new features because the lack of doc coverage. 

      What

      We should review/update the internal usage guide to make sure that it is complete and accurate.    We should publish it to GitHub e.g. https://github.com/redhat-developer/gitops-operator

      Once we publish usage guide to GitHub, we should only maintain the copy of doc in GitHub.   We should look into doc hosting partner like https://readthedocs.org/ which can maintain different release version of docs.

      Acceptance Criteria

      • Publish internal usage guide to GitHub
      • Use doc hosting e.g. https://readthedocs.org/ to improve doc style and support multi-version (ok to note version in the doc).

            jfischer@redhat.com Jann Fischer
            wtam_at_redhat William Tam
            Votes:
            1 Vote for this issue
            Watchers:
            5 Start watching this issue

              Created:
              Updated:
              Resolved: