tracking issue for doc template changes on top of edp1.2+

[clemensutschig]

Tracking changes to docs:

SSDS

• [ ] SSDS-1: gamp 3 - remove chapters: 2.2 / 2.3 / 3.2.1 / 3.2.2 / 8 / 9 / 10 / 11 / 12 @clemensutschig I am not for a simple removal of unused chapters, since chapter would mismatch with documentation chapter numbers in Jira
• [x] SSDS-2: gamp 3 / 4 - interfaces (missing doc chapters)
• [ ] SSDS-3: gamp 4 - system data (8 / 9 / 10) are template HARDCODED ... and need to be JIRA'd instead /take from GAMP 5 SSDS template

TIP

• [x] TIP-1 - verification of non ods installed components (section 6)

CFTP

• [x] CFTP-1: rename 7.1.1 to "Combined functional and requirements testing" - update TOC (see https://github.com/opendevstack/ods-document-generation-templates/pull/73/commits/a88dbccc8e84c10b9a72230b2c463dffaab8e4ba)

• [x] CFTP-2: 5.2 - change "maintaining the Infrastructure System" to " maintaining the System/Application" (see https://github.com/opendevstack/ods-document-generation-templates/pull/73/commits/37cc719630cb9cb80edd25d913fcab3de7c5c6a7)

• [x] CFTP-3: 4.1 - change to (see https://github.com/opendevstack/ods-document-generation-templates/pull/73/commits/892cd60dfe38840b8a9ee7ea4bf007c35f194aa1)

  The objective of the Integration Testing level is to verify whether the applicable components (e.g. modules, micro-services and/or systems) work well together and detect flaws in their interactions.
  Integration Testing is part of the Combined Functional/Requirements Test Plan (C-CFTP) and Report (C-CFTR).`

• [x] CFTP-4: 4.2 - change

  (....) Acceptance Testing

  @clemensutschig not sure what you mean. Chapter 4.2 seems good to me.

• [x] CFTP-5: Simplify chapter Levels of Testing (see https://github.com/opendevstack/ods-document-generation-templates/pull/73/commits/37aae9f0f8101c1ef758483569a48bc0db776fce)

• [x] CFTP-6: Make Chapter 6 Training a free-form chapter (see https://github.com/opendevstack/ods-document-generation-templates/pull/73/commits/7205420e20f9c92cd297cebc1ed4356b9611bb14) Note by @metmajer: turns out the the latest C-FTP LeVA template has the text we have in the template as an exemplary blue text only.

• [x] CFTP-7: Change "code base tests" to "tests" under Chapter 8.2 Test Execution (see https://github.com/opendevstack/ods-document-generation-templates/pull/73/commits/64c9d6906b9b65c81882e9af8ace64ee99a2d10f)

• [x] CFTP-8: Consolidate 4.2.1 and 4.2.2 into 4.2 (see https://github.com/opendevstack/ods-document-generation-templates/pull/73/commits/cec8d39bd4accbe009bb256ad611c4eada3b8ae6)

• [X] CFTP-9: Structure Chapter 8.2 Test Execution into Automated and Manual Test Execution. Extract free-text section to the bottom (see https://github.com/opendevstack/ods-document-generation-templates/pull/73/commits/366185df0f33aafb814ed338c96919a9db1452d3)

• [X] CFTP-10: Add proper description for automated tests where roles like Tester and Test Administrator do not exist (see https://github.com/opendevstack/ods-document-generation-templates/pull/73/commits/3dd9eb94250aceba022ccecf58edfefda0cbad60)

• [X] CFTP-11: Improve problem resolution of automated tests in Chapter 11 (see https://github.com/opendevstack/ods-document-generation-templates/pull/73/commits/2f145c5ad71fa360aa514f2e61d78bc5607b665d).

CIT/IVP

• [ ] CIT / IVP .. could we make this smarter?

[clemensutschig]

SSDS interfaces: / Gamp4 :)

            <h4><span>3.2.2</span> Interfaces between Modules</h4>
            <p>N/A</p>
            <h4><span>3.2.3</span> Interfaces to External Systems</h4>
            <p>N/A</p>
            <h4><span>3.2.4</span> System Diagram</h4>
            <p>N/A</p>

vs GAMP 5:

            <h4><span>3.2.3</span> Interfaces to External Systems</h4>
            <table class="no-border">
                <tr>
                    <td class="content-wrappable no-border">{{{data.sections.sec3s2s3.content}}}</td>
                </tr>
            </table>

[clemensutschig]

@metmajer - we should fix this asap in a joint session

[clemensutschig]

TIP - section 6 - needs to change for non-installed components:

        <p>Each component comes with individual installation tests. For details look in the Technical Installation Report.</p>
        {{#each data.repositories}}
        <h3>Component {{id}}</h3>

        <table class="no-page-break">
            <tr>
                <th class="lean">Step</th>
                <th class="content-wrappable">Instruction for Testing</th>
                <th class="content-wrappable">Expected Result</th>
                <th class="content-wrappable">Actual Result</th>
                <th class="lean">Pass / Fail</th>
            </tr>
            <tr>
                <td class="lean">1</td>
                <td class="content-wrappable">Component has been deployed and individual installation tests ran.</td>
                <td class="content-wrappable">Component has been successfully deployed. All installation tests ran successfully.</td>
                <td class="content-wrappable">N/A</td>
                <td class="content-wrappable">N/A</td>
            </tr>