Uploaded image for project: 'Docs for Red Hat Developers'
  1. Docs for Red Hat Developers
  2. RHDEVDOCS-3759

Introduce the GH CLI README in the docs

XMLWordPrintable

    • Documentation (Ref Guide, User Guide, etc.), User Experience

      I am opening this issue because it is part of the response to https://issues.redhat.com/browse/CRW-2719

      I suggest that this issue is added to https://issues.redhat.com/browse/RHDEVDOCS-2555 or another epic.

      One of the problems of the old docs that I noticed was disorganized (due to granular contributions to the docs by developers) description of the CLI commands that are listed in the corresponding READMEs:

      https://github.com/redhat-developer/codeready-workspaces-chectl/
      https://github.com/che-incubator/chectl/

      Although we obviously cannot rule out ever having to document a procedure about a CLI command that is already listed in the README, we can organize this workflow and limit the scope of CLI commands (that are already documented in the README) to be ever documented in the docs.

      My initial proposal to do so is to introduce the GitHub README (with ifeval for upstream/downstream README version?) in a concept section as a starting step. This way, docs readers will know where to go to find all CLI commands, and we'll be more conservative regarding future demands for documenting some CLI in the docs in addition to the README.

      If the README is unclear, we may instead improve the README rather than create new modules in the docs.

      This will help reduce our docs overhead both in terms of creating new content (having to document CLI commands in the new docs because they were documented in the old docs) and in terms of maintaining created content (changes in CLI commands).

            Unassigned Unassigned
            rhn-support-mleonov Max Leonov
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: