Uploaded image for project: 'BxMS Documentation'
  1. BxMS Documentation
  2. BXMSDOC-4174 Restructure based on Freeform - immutable doc
  3. BXMSDOC-4218

PEer review: doc restructuring (plus Startup Strategy maturation)

XMLWordPrintable

    • Icon: Sub-task Sub-task
    • Resolution: Done
    • Icon: Major Major
    • None
    • None
    • None
    • None
    • 2019 Week 20-22, 2019 Week 23-25

      Hello Stetson,

      I'm afraid you would be the only one who can handle this peer review. The restructuring took longer than I hoped it would , as there were both distractions from other quarters and important questions raised while I was doing it (which even led to a BAPL being moved to 7.4.0 and acked at the very last moment). And I have something like four tasks blocked as dependencies of this one.

      PR: https://github.com/mramendi/kie-docs/pull/45

      Note that I have made some changes to attribute files and to other docs that link to my docs. Links to APB and Operator docs were added. A couple of doc titles were update for the restructuring. Links to PAM and DM specific docs were conditionalized, so adding a non-working link (like linking to the Authoring doc when building a DM doc) will now cause a build break and no longer cause 404 links.

      Rendered docs:

      PAM Authoring environment http://file.ork.redhat.com/~mramendi/restruc-pam-authoring/ (authoring template)

      DM Authoring and Managed environment http://file.ork.redhat.com/~mramendi/restruc-dm-authoring-managed/ (this is the authoring template and the kieserver template that can be added to it; the fact that immutable can be connected to the same BC is now mentioned)

      PAM Freeform Managed environment http://file.ork.redhat.com/~mramendi/restruc-pam-freeform/ (the managed and KIE server templates; this doc no longer includes immutable deployment, and references the immutable doc instead)

      PAM Fixed Managed environment (the prod template with no Startup Strategy): http://file.ork.redhat.com/~mramendi/restruc-pam-managed/

      PAM Immutable document http://file.ork.redhat.com/~mramendi/restruc-pam-immutable/ (includes the immutable S2I, immutable KJAR, and monitoring; monitoring moved to the end of the document as it is optional and no longer has to be deployed first). Note: discussion of Git updates for S2I was specifically not included as it will require separate review

      DM Immutable document http://file.ork.redhat.com/~mramendi/restruc-dm-immutable/ (includes immutable S2I, immutable KJAR)

      In the review:

      • No need to review all parameters, they are copied from older versions of docs, as is most other text.
      • Please do review the descriptive parts before the install procedures as they were heavily rewritten for Startup Strategy reasons (in the "Fixed Managed" doc that has no Startup Strategy, I clarified the difference from Startup Strategy)

            sterobin@redhat.com Stetson Robinson (Inactive)
            mramendi Mikhail Ramendik
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: