Uploaded image for project: 'Red Hat Fuse'
  1. Red Hat Fuse
  2. ENTESB-18092

Simplify the maintenance of CE4Q documentation

XMLWordPrintable

    • False
    • False
    • % %
    • Todo

      The way the CE4Q documentation was written by the docs team for the release 2.2.0 and reviewed by ENG and QE is not sustainable.

      The engineering team spends quite a lot of energy writing and maintaining the community documentation. But this is used only as a very loose inspiration by the docs team. The docs team maps the content to a different structure and the text is rephrased on many places.

      While the result may bring a better value (compared to community) to end users, the process has to be manually repeated for every CE4Q release thus not only spending time of the docs team but also of ENG and QE engineers.

      It would be nice if we could simplify the process as much as possible.

      Here is a couple of ideas:

      • Agree on the general structure and have the same in the community and in the product
      • Parametrize the community content using AsciiDoc/Antora attributes/placeholders (product names, versions, etc.)
      • Impose the "upstream first" rule (honored in 99.999% cases for the code) also for the docs texts. In other words, any rewording in the prod docs would not be accepted unless there is an (ideally merged) PR bringing the same change to the upstream.

      cc vkasala@redhat.com

            Unassigned Unassigned
            ppalaga Peter Palaga
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: