diff --git a/CHANGELOG.md b/CHANGELOG.md index abc7605..2442994 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,11 @@ ## Unreleased +## 1.2.11 - 2025-4-10 +- Remove Jira issue ID strikethrough on SLC documents. ([#153](https://github.com/opendevstack/ods-document-generation-templates/pull/153)) +- Make content in column Test Case No. wrappable. ([#152](https://github.com/opendevstack/ods-document-generation-templates/pull/152)) +- TIR changes: Wording changes to be more inclusive of helm deployments, removed dynamic values from report tables and change in table formatting ([#146](https://github.com/opendevstack/ods-document-generation-templates/pull/146)) & ([#154](https://github.com/opendevstack/ods-document-generation-templates/pull/154)) + ## 1.2.10 - 2025-1-27 - Remove "Initials/Date" from TCP and TCR documents. ([#150](https://github.com/opendevstack/ods-document-generation-templates/pull/150)) - Update TRC reference document with SSDS and TCP ([#149](https://github.com/opendevstack/ods-document-generation-templates/pull/149)) diff --git a/css/styles.css b/css/styles.css index 84a0897..e783b7c 100644 --- a/css/styles.css +++ b/css/styles.css @@ -47,6 +47,9 @@ h5 span { margin-right: 1.5em; } +del { + text-decoration: none; +} input + label { margin-left: 0.5em; @@ -168,6 +171,27 @@ td.content-wrappable table th, td.content-wrappable table td { white-space: normal; } +/* Remove all spacing around .inner-ul-2 elements */ + +td > ul.inner-ul { + list-style-type: none; + padding: 0em; + margin: 0em; +} + +li > ul.inner-ul { + list-style-type: none; + padding-left: 1em; + padding-right: 0em; + padding-top: 0em; + padding-bottom: 0em; +} + +.inner-span { + display: inline-block; + margin-right: 0em; +} + .center { text-align: center; } diff --git a/scripts/scripts.js b/scripts/scripts.js index 386c5fc..a9a37ab 100644 --- a/scripts/scripts.js +++ b/scripts/scripts.js @@ -1,21 +1,39 @@ function subst() { - var vars = {}; + var vars = {}; - var query_strings_from_url = document.location.search.substring(1).split('&'); - for (var query_string in query_strings_from_url) { - if (query_strings_from_url.hasOwnProperty(query_string)) { - var temp_var = query_strings_from_url[query_string].split('=', 2); - vars[temp_var[0]] = decodeURI(temp_var[1]); + var query_strings_from_url = document.location.search + .substring(1) + .split("&"); + for (var query_string in query_strings_from_url) { + if (query_strings_from_url.hasOwnProperty(query_string)) { + var temp_var = query_strings_from_url[query_string].split("=", 2); + vars[temp_var[0]] = decodeURI(temp_var[1]); + } } - } - var css_selector_classes = ['page', 'frompage', 'topage', 'webpage', 'section', 'subsection', 'date', 'isodate', 'time', 'title', 'doctitle', 'sitepage', 'sitepages']; - for (var css_class in css_selector_classes) { - if (css_selector_classes.hasOwnProperty(css_class)) { - var element = document.getElementsByClassName(css_selector_classes[css_class]); - for (var j = 0; j < element.length; ++j) { - element[j].textContent = vars[css_selector_classes[css_class]]; - } + var css_selector_classes = [ + "page", + "frompage", + "topage", + "webpage", + "section", + "subsection", + "date", + "isodate", + "time", + "title", + "doctitle", + "sitepage", + "sitepages", + ]; + for (var css_class in css_selector_classes) { + if (css_selector_classes.hasOwnProperty(css_class)) { + var element = document.getElementsByClassName( + css_selector_classes[css_class] + ); + for (var j = 0; j < element.length; ++j) { + element[j].textContent = vars[css_selector_classes[css_class]]; + } + } } - } } diff --git a/templates/DIL.html.tmpl b/templates/DIL.html.tmpl index 6caab57..4e73aed 100644 --- a/templates/DIL.html.tmpl +++ b/templates/DIL.html.tmpl @@ -82,7 +82,7 @@ - + @@ -94,7 +94,7 @@ {{#each data.integrationTests}} - + @@ -122,7 +122,7 @@
Discrepancy IDTest Case No.Test Case No. Level of Test Case Description of Failure or Discrepancy Remediation Action
{{discrepancyID}}{{testcaseID}}{{testcaseID}} Integration {{{description}}} {{{remediation}}}
- + @@ -134,7 +134,7 @@ {{#each data.acceptanceTests}} - + diff --git a/templates/TIR.html.tmpl b/templates/TIR.html.tmpl index 36a2756..50e39c0 100644 --- a/templates/TIR.html.tmpl +++ b/templates/TIR.html.tmpl @@ -1,384 +1,647 @@ + + Technical Installation Report for '{{ metadata.name }}' + + + +
+
Discrepancy IDTest Case No.Test Case No. Level of Test Case Description of Failure or Discrepancy Remediation Action
{{discrepancyID}}{{testcaseID}}{{testcaseID}} Acceptance {{{description}}} {{{remediation}}}
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Information
+ Name: + + {{ metadata.name }} +
+ Description: + + {{ metadata.description }} +
+ Version: + + {{ metadata.version }}/{{ data.documentHistoryLatestVersionId }} +
Date Created: + {{ metadata.date_created }} +
Git Commit: + {{ metadata.git.commit }} +
Git Tag: + {{ metadata.git.targetTag }} +
Git URL: + {{ metadata.git.url }} +
OpenShift Cluster API URL: + {{ metadata.openShift.apiUrl }} +
+ Created by Jenkins Job Name: + + {{ metadata.jenkins.jobName }} +
+ Created by Jenkins Build Number: + + {{ metadata.jenkins.buildNumber }} +
Target environment: + {{ metadata.buildParameter.targetEnvironment }} +
+
- - Technical Installation Report for '{{metadata.name}}' - - - - -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Information -
Name:{{metadata.name}}
Description:{{metadata.description}}
Version:{{metadata.version}}/{{data.documentHistoryLatestVersionId}}
Date Created:{{metadata.date_created}}
Git Commit:{{metadata.git.commit}}
Git Tag:{{metadata.git.targetTag}}
Git URL:{{metadata.git.url}}
OpenShift Cluster API URL:{{metadata.openShift.apiUrl}}
Created by Jenkins Job Name:{{metadata.jenkins.jobName}}
Created by Jenkins Build Number:{{metadata.jenkins.buildNumber}}
Target environment:{{metadata.buildParameter.targetEnvironment}}
-
- -
 
- -

Technical Installation Report for '{{metadata.name}}'

- -

Table of Contents

-
    -
  1. Introduction
    2. -
  2. Installation
    3. -
  3. Diagnostics and Testing
    4. -
  4. Conclusion Statement
    5. -
  5. Definitions and Abbreviations -
      -
    1. Definitions
      2. -
    2. Abbreviations
      3. -
    -
    6. -
  6. Reference Documents
    7. -
  7. Document History
    8. -
-
- -
-

1Introduction

- -

This document describes the installation of the software-defined component {{data.repo.id}}. The installation is based on the corresponding Technical Installation Plan (TIP) of Config Item: {{metadata.buildParameter.configItem}}.

+
 
-

The plan outlines additional chapters, namely Installation Prerequisites (3) and Environmental Conditions (4).

+

Technical Installation Report for '{{ metadata.name }}'

-

Installation plan reference: ITEMS Document Number {{metadata.version}}-{{metadata.jenkins.buildNumber}}, Version: {{metadata.referencedDocs.TIP}}.

+

Table of Contents

+
    +
  1. Introduction
    2. +
  2. Installation
    3. +
  3. Diagnostics and Testing
    4. +
  4. Conclusion Statement
    5. +
  5. + Definitions and Abbreviations +
      +
    1. Definitions
      2. +
    2. Abbreviations
      3. +
    +
    6. +
  6. Reference Documents
    7. +
  7. Document History
    8. +
+
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Parameters
ParameterValue
Git Commit Component {{id}}{{data.repo.data.git.commit}}
Git Repo Component {{id}}{{data.repo.data.git.url}}
ODS Component Type {{id}}{{data.repo.type}}
Environment{{metadata.buildParameter.targetEnvironment}}
Change Description{{metadata.buildParameter.changeDescription}}
Version{{metadata.buildParameter.version}}
Config Item{{metadata.buildParameter.configItem}}
- +
+

1Introduction

-
-

2Installation

-

Installations steps have been successfully conducted. Overall installation status:

+

+ This document describes the installation of the software-defined + component {{ data.repo.id }}. The installation is based on the corresponding Technical + Installation Plan (TIP) of Config Item: + {{ metadata.buildParameter.configItem }}. +

- - - - - -
StatusOK
+

+ The plan outlines additional chapters, namely + Installation Prerequisites (3) and + Environmental Conditions (4). +

-

2.1Jenkins

-

Jenkins Job has been successfully executed:

+

+ Installation plan reference: ITEMS Document Number + {{ metadata.version }}-{{ metadata.jenkins.buildNumber }}, Version: {{ metadata.referencedDocs.TIP }}. +

- - - - - - +

Parameters

+
NameValue
+ + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + - - + + +
Parameters
ParameterValue
+ Git Commit Component {{ id }} + + {{ data.repo.data.git.commit }} +
+ Git Repo Component {{ id }} + + {{ data.repo.data.git.url }} +
+ ODS Component Type {{ id }} + {{ data.repo.type }}
Environment + {{ metadata.buildParameter.targetEnvironment }} +
Change Description + {{ metadata.buildParameter.changeDescription }} +
Job Number{{metadata.jenkins.buildNumber}}Version + {{ metadata.buildParameter.version }} +
Job Name{{metadata.jenkins.jobName}}Config Item + {{ metadata.buildParameter.configItem }} +
+
+ +
+

2Installation

+

+ Installations steps have been successfully conducted. Overall + installation status: +

+ + - - + + - -
Build URL{{metadata.jenkins.buildUrl}}StatusOK
+ -

2.2Components

-

Note: {{deployNote}}

+

2.1Jenkins

+

Jenkins Job has been successfully executed:

- {{#data.repo}} -

The following components have been successfully installed:{{id}}

- {{#openShiftData}} - - {{#builds}} - -
- {{#each .}} +
+ + + + + + + + + + + + + + +
Job Number + {{ metadata.jenkins.buildNumber }} +
Job Name + {{ metadata.jenkins.jobName }} +
Build URL + {{ metadata.jenkins.buildUrl }} +
+ +

2.2Component

+

Note: {{ deployNote }}

+ + {{#data.repo}} +

+ The following component has been successfully installed: + {{ id }} +

+ {{/data.repo}} + + {{#openShiftData}} + {{#builds}} - Build Resource: {{@key}} -
- - - - - +
NameValue
{{#each .}} - - - + + Build Resource: + {{@key}} +
{{@key}}{{.}}
+ + {{#each .}} + + + + + {{/each}} + +
{{@key}}{{.}}
+ {{/each}} - - + + + {{/builds}} + {{/openShiftData}} + + {{^legacy}} + {{#deploymentMean}} + + + + Deployment +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Namespace + {{ namespace }} +
Managed by + {{ type }} +
+ Source repository + + + {{../data/repo/url}} +
+ Descriptor path + + {{ descriptorPath }} +
+ Environment configuration files + + {{{envConfigFiles}}} +
+ Global configuration files + + {{{configFiles}}} +
+ Configuration parameters + + {{{configParams}}} +
+ Default command line flags + + {{{defaultCmdLineArgs}}} +
+ Additional command line flags + + {{{additionalCmdLineArgs}}} +
+ + {{#deploymentStatus}} + + Deployment Result + + + + + + + + + + + + + + + + + + + +
Status + {{ deployStatus }} +
+ Result message + + {{ resultMessage }} +
Timestamp + {{ lastDeployed }} +
Resources + {{{resources}}} +
+ + {{/deploymentStatus}} + + + {{/deploymentMean}} + {{/legacy}} + + {{#legacy}} + {{#deploymentMean}} + + + + Deployment +
+ + + + + + {{#each .}} + + + + + {{/each}} + +
NameValue
{{@key}} + {{ this }} +
+ + - {{/each}} - - - {{/builds}} - {{#deployments}} - - - {{#each .}} + {{/deploymentMean}} + {{#openShiftData}} + {{#deployments}} - Deployment Resource: {{@key}} -
- - - - - +
NameValue
{{#each .}} - - - + + Deployment Resource: + {{@key}} +
{{@key}}{{this}}
+ + + + + + {{#each .}} + + + + + {{/each}} + +
NameValue
{{@key}} + {{ this }} +
+ {{/each}} - - + - {{/each}} - - - {{/deployments}} - - {{/openShiftData}} - {{/data.repo}} -
- -
-

3Diagnostics and Testing

-

Diagnostic steps have been successfully applied to the requested component.

- -

Diagnostic Status

- - - - - -
StatusOK
+ {{/deployments}} + {{/openShiftData}} + {{/legacy}} + +
-

Diagnostic Result

+
+

3Diagnostics and Testing

+

+ Diagnostic steps have been successfully applied to the requested + component. +

- {{#data.repo}} -

Component {{id}}

- - - - - - - - - +

Diagnostic Status

+
StepInstruction for TestingExpected ResultActual ResultPass / Fail
- - - - - + + - - - - - - - - -
1automated configuration appplication (Q/P environment)Configuration appliedConfiguration appliedpassStatusOK
2POD is runningPOD is in status runningPOD is in status runningpass
- {{/data.repo }} -
+ -
-

4Conclusion Statement

-

All deliverables of the Technical Installation Plan have been successfully executed and the signature of this Report verifies that the system has been installed according to all requirements stated in the Installation Plan or, in the event the requirements are not met, that the deviations and/or failures are properly documented and addressed.

-
+

Diagnostic Result

-
-

5Definitions and Abbreviations

+ {{#data.repo}} +

Component {{ id }}

+ + + + + + + + + + + + + + + + + + + + + + + + +
StepInstruction for TestingExpected ResultActual ResultPass / Fail
1 + Automated configuration appplication (Q/P + environment) + Configuration appliedConfiguration appliedPass
2 + Wait until all Pods, PVCs, Services, and minimum + number of Pods of a Deployment, StatefulSet, or + ReplicaSet are in a ready state + + Applicable resources are in ready state + + Applicable resources are in ready state + Pass
+ {{/data.repo}} +
-

5.1Definitions

- {{#if data.sections.sec5s1.show}} +
+

4Conclusion Statement

+

+ All deliverables of the Technical Installation Plan have been + successfully executed and the signature of this Report verifies + that the system has been installed according to all requirements + stated in the Installation Plan or, in the event the + requirements are not met, that the deviations and/or failures + are properly documented and addressed. +

+
+ +
+

5Definitions and Abbreviations

+ +

5.1Definitions

+ {{#if data.sections.sec5s1.show}} - +
{{{data.sections.sec5s1.content}}} + {{{data.sections.sec5s1.content}}} +
- {{else}} + {{else}}

N/A

- {{/if}} + {{/if}} -

5.2Abbreviations

- {{#if data.sections.sec5s2.show}} +

5.2Abbreviations

+ {{#if data.sections.sec5s2.show}} - +
{{{data.sections.sec5s2.content}}} + {{{data.sections.sec5s2.content}}} +
- {{else}} + {{else}}

N/A

- {{/if}} -
+ {{/if}} +
-
-

6Reference Documents

- - {{#if data.sections.sec6.show}} +
+

6Reference Documents

+ + {{#if data.sections.sec6.show}} - +
{{{data.sections.sec6.content}}} + {{{data.sections.sec6.content}}} +
- {{/if}} -
+ {{/if}} +
-
-

7Document History

- {{#if data.documentHistory}} - - - - - - - - - {{#each data.documentHistory}} - - - - + + {{/each}} + +
VersionDateAuthorChange Reference
{{{docVersion}}}See Summary of electronic document or signature page of printout. - {{{rational}}} -
- {{#each issueType}} - {{#if added}} - The following {{type}} were added: -
    - {{#each added}} -
  • {{key}}{{#if details}}: {{details}}{{/if}}
    • +
    +

    7Document History

    + {{#if data.documentHistory}} + + + + + + + + + {{#each data.documentHistory}} + + + + - - {{/each}} - -
    VersionDateAuthorChange Reference
    {{{docVersion}}} + See Summary of electronic document or signature page + of printout. + + {{{rational}}} +
    + {{#each issueType}} + {{#if added}} + The following {{ type }} were added: +
      + {{#each added}} +
    • + {{ key }}{{#if details}}: {{ details }}{{/if}} +
      • + {{/each}} +
    + {{/if}} + {{#if discontinued}} + The following {{ type }} were removed: +
      + {{#each discontinued}} +
    • + {{ key }}{{#if details}}: {{ details }}{{/if}} +
      • + {{/each}} +
    + {{/if}} + {{#if changed}} + The following {{ type }} were changed: +
      + {{#each changed}} +
    • + {{ key }} was previously {{ predecessors }}{{#if details}}: {{ details }}{{/if}} +
      • + {{/each}} +
    + {{/if}} +
    {{/each}} - - {{/if}} - {{#if discontinued}} - The following {{type}} were removed: -
      - {{#each discontinued}} -
    • {{key}}{{#if details}}: {{details}}{{/if}}
      • - {{/each}} -
    - {{/if}} - {{#if changed}} - The following {{type}} were changed: -
      - {{#each changed}} -
    • {{key}} was previously {{predecessors}}{{#if details}}: {{details}}{{/if}}
      • - {{/each}} -
    - {{/if}} -
    - {{/each}} -
    - {{/if}} - {{#if data.sections.sec7.show}} +
+ {{/if}} + {{#if data.sections.sec7.show}} - +
{{{data.sections.sec7.content}}} + {{{data.sections.sec7.content}}} +
- {{/if}} -
- + {{/if}} + +