Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
13 of 16 tasks
clemensutschig opened this issue Dec 2, 2021 · 3 comments · Fixed by #68 or #69 · May be fixed by #70 or #71
Open
13 of 16 tasks

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

clemensutschig opened this issue Dec 2, 2021 · 3 comments · Fixed by #68 or #69 · May be fixed by #70 or #71
Assignees
Labels
bug Something isn't working

Comments

@clemensutschig
Copy link
Member

clemensutschig commented Dec 2, 2021

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
  • 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

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

CFTP

  • CFTP-1: rename 7.1.1 to "Combined functional and requirements testing" - update TOC (see a88dbcc)
  • CFTP-2: 5.2 - change "maintaining the Infrastructure System" to " maintaining the System/Application" (see 37cc719)
  • CFTP-3: 4.1 - change to (see 892cd60)
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).`
  • CFTP-4: 4.2 - change
(....) Acceptance Testing

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

  • CFTP-5: Simplify chapter Levels of Testing (see 37aae9f)
  • CFTP-6: Make Chapter 6 Training a free-form chapter (see 7205420)
    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.
  • CFTP-7: Change "code base tests" to "tests" under Chapter 8.2 Test Execution (see 64c9d69)
  • CFTP-8: Consolidate 4.2.1 and 4.2.2 into 4.2 (see cec8d39)
  • CFTP-9: Structure Chapter 8.2 Test Execution into Automated and Manual Test Execution. Extract free-text section to the bottom (see 366185d)
  • CFTP-10: Add proper description for automated tests where roles like Tester and Test Administrator do not exist (see 3dd9eb9)
  • CFTP-11: Improve problem resolution of automated tests in Chapter 11 (see 2f145c5).

CIT/IVP

  • CIT / IVP .. could we make this smarter?
@clemensutschig
Copy link
Member Author

clemensutschig commented Dec 13, 2021

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 clemensutschig added the bug Something isn't working label Dec 13, 2021
@clemensutschig
Copy link
Member Author

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

@clemensutschig
Copy link
Member Author

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>

@clemensutschig clemensutschig self-assigned this Dec 15, 2021
@clemensutschig clemensutschig changed the title tracking issue for doc changes edp1.2+ tracking issue for doc template changes on top of edp1.2+ Dec 15, 2021
@clemensutschig clemensutschig added this to To Do in OpenDevStack 4.1.0 via automation Jan 12, 2022
@metmajer metmajer removed this from To Do in OpenDevStack 4.1.0 Apr 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment