Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## Unreleased

## 1.2.12 - 2025-4-29
- Fixed html parser errors. ([#158](https://github.com/opendevstack/ods-document-generation-templates/pull/158))
- 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))
Expand Down
24 changes: 24 additions & 0 deletions css/styles.css
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ h5 span {
margin-right: 1.5em;
}

del {
text-decoration: none;
}

input + label {
margin-left: 0.5em;
Expand Down Expand Up @@ -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;
}
Expand Down
48 changes: 33 additions & 15 deletions scripts/scripts.js
Original file line number Diff line number Diff line change
@@ -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]];
}
}
}
}
}
1 change: 1 addition & 0 deletions templates/CSD-3.html.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -742,6 +742,7 @@
<td class="lean">URS</td>
<td class="content-wrappable">Summary: {{{ursName}}}{{#if ursDescription}}<br>{{{ursDescription}}}{{/if}}</td>
<td class="lean">{{applicability}}</td>
</tr>
<tr>
<td class="lean">FS</td>
<td class="content-wrappable">Summary: {{{fsName}}}{{#if fsDescription}}<br>{{{fsDescription}}}{{/if}}</td>
Expand Down
1 change: 1 addition & 0 deletions templates/CSD-5.html.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,7 @@
<td class="lean">{{applicability}}</td>
</tr>
{{/each}}
</tbody>
</table>
{{/each}}
{{else}}
Expand Down
10 changes: 5 additions & 5 deletions templates/DIL.html.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
<h1>Functional / Requirements Testing Discrepancy Log</h1>

<p>This Discrepancy Log is to be used for documentation of any discrepancies (e.g. failed test cases, test case errors, testing execution errors) found during testing. These should include all test cases where the result has been set to failed.</p>
<p><em>Clarification: Discrepancies detected during a test run will be documented in the Discrepancy Log (DIL) version associated with the test run. The DIL will be created during each test run. Any updated version of the DIL showing no discrepancies serves as evidence for the successful correction of the error(s) causing the discrepancies.</br>
<p><em>Clarification: Discrepancies detected during a test run will be documented in the Discrepancy Log (DIL) version associated with the test run. The DIL will be created during each test run. Any updated version of the DIL showing no discrepancies serves as evidence for the successful correction of the error(s) causing the discrepancies.<br/>
Furthermore, this discrepancy log only covers discrepancies from tasks automated through OpenDevStack. Any manual tasks done outside of OpenDevStack, which created discrepancies, must be covered in a secondary DIL.</em></p>

<h2>Integration Testing Discrepancy Log</h2>
Expand All @@ -82,7 +82,7 @@
<table>
<thead>
<th style="white-space: nowrap">Discrepancy ID</th>
<th style="white-space: nowrap">Test Case No.</th>
<th class="content-wrappable">Test Case No.</th>
<th class="content-wrappable">Level of Test Case</th>
<th class="content-wrappable">Description of Failure or Discrepancy</th>
<th class="content-wrappable">Remediation Action</th>
Expand All @@ -94,7 +94,7 @@
{{#each data.integrationTests}}
<tr>
<td style="white-space: nowrap">{{discrepancyID}}</td>
<td style="white-space: nowrap">{{testcaseID}}</td>
<td class="content-wrappable">{{testcaseID}}</td>
<td class="content-wrappable">Integration</td>
<td class="hyphenate">{{{description}}}</td>
<td class="content-wrappable">{{{remediation}}}</td>
Expand Down Expand Up @@ -122,7 +122,7 @@
<table>
<thead>
<th style="white-space: nowrap">Discrepancy ID</th>
<th style="white-space: nowrap">Test Case No.</th>
<th class="content-wrappable">Test Case No.</th>
<th class="content-wrappable">Level of Test Case</th>
<th class="content-wrappable">Description of Failure or Discrepancy</th>
<th class="content-wrappable">Remediation Action</th>
Expand All @@ -134,7 +134,7 @@
{{#each data.acceptanceTests}}
<tr>
<td style="white-space: nowrap">{{discrepancyID}}</td>
<td style="white-space: nowrap">{{testcaseID}}</td>
<td class="content-wrappable">{{testcaseID}}</td>
<td class="content-wrappable">Acceptance</td>
<td class="hyphenate">{{{description}}}</td>
<td class="content-wrappable">{{{remediation}}}</td>
Expand Down
6 changes: 3 additions & 3 deletions templates/IVP.html.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -312,10 +312,10 @@ Other test cases:
<td class="content-wrappable">
{{#if steps}}
<ol>
{{#each steps}}
{{#each steps}}
<li>{{step}}</li>
{{/each}}
<p>N/A</p>/ol>
{{/each}}
</ol>
{{else}}
No test steps defined
{{/if}}
Expand Down
2 changes: 1 addition & 1 deletion templates/RA.html.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -451,7 +451,7 @@
<tr>
<td class="lean">{{key}}</td>
<td class="lean">{{type}}</td>
<td class="content-wrappable">{{{name}}}</br>{{{description}}}</td>
<td class="content-wrappable">{{{name}}}<br/>{{{description}}}</td>
<td class="lean">{{referencesRisk}}</td>
</tr>
{{/each}}
Expand Down
2 changes: 1 addition & 1 deletion templates/SSDS-1.html.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@
{{/if}}
{{#if data.sections.sec16s1.bitbucket}}
<p>
A Bitbucket Pull Request (PR) is where contributors and reviewers meet to discuss and assert the readiness of a contribution to a Bitbucket repository comprising code, tests, configuration, or a combination of these.</br>
A Bitbucket Pull Request (PR) is where contributors and reviewers meet to discuss and assert the readiness of a contribution to a Bitbucket repository comprising code, tests, configuration, or a combination of these.<br/>
<br/>
A person who creates a PR gets attributed as its author and nominates at least one reviewer. Once mandatory changes requested by the reviewers have been incorporated by the contributors, reviewers can approve the PR. An approval permits that the approved contribution can be merged from a temporary source branch into a longer living target branch inside the repository.{{#if metadata.gxp}} A single person must not assume the roles of contributor and reviewer on the same PR (no self-approvals).{{/if}}<br/>
<br/>
Expand Down
2 changes: 1 addition & 1 deletion templates/SSDS-3.html.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@
{{/if}}
{{#if data.sections.sec16s1.bitbucket}}
<p>
A Bitbucket Pull Request (PR) is where contributors and reviewers meet to discuss and assert the readiness of a contribution to a Bitbucket repository comprising code, tests, configuration, or a combination of these.</br>
A Bitbucket Pull Request (PR) is where contributors and reviewers meet to discuss and assert the readiness of a contribution to a Bitbucket repository comprising code, tests, configuration, or a combination of these.<br/>
<br/>
A person who creates a PR gets attributed as its author and nominates at least one reviewer. Once mandatory changes requested by the reviewers have been incorporated by the contributors, reviewers can approve the PR. An approval permits that the approved contribution can be merged from a temporary source branch into a longer living target branch inside the repository.{{#if metadata.gxp}} A single person must not assume the roles of contributor and reviewer on the same PR (no self-approvals).{{/if}}<br/>
<br/>
Expand Down
2 changes: 1 addition & 1 deletion templates/SSDS-4.html.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@
{{/if}}
{{#if data.sections.sec16s1.bitbucket}}
<p>
A Bitbucket Pull Request (PR) is where contributors and reviewers meet to discuss and assert the readiness of a contribution to a Bitbucket repository comprising code, tests, configuration, or a combination of these.</br>
A Bitbucket Pull Request (PR) is where contributors and reviewers meet to discuss and assert the readiness of a contribution to a Bitbucket repository comprising code, tests, configuration, or a combination of these.<br/>
<br/>
A person who creates a PR gets attributed as its author and nominates at least one reviewer. Once mandatory changes requested by the reviewers have been incorporated by the contributors, reviewers can approve the PR. An approval permits that the approved contribution can be merged from a temporary source branch into a longer living target branch inside the repository.{{#if metadata.gxp}} A single person must not assume the roles of contributor and reviewer on the same PR (no self-approvals).{{/if}}<br/>
<br/>
Expand Down
2 changes: 1 addition & 1 deletion templates/SSDS-5.html.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@
</table>
{{/if}}
<p>
A Bitbucket Pull Request (PR) is where contributors and reviewers meet to discuss and assert the readiness of a contribution to a Bitbucket repository comprising code, tests, configuration, or a combination of these.</br>
A Bitbucket Pull Request (PR) is where contributors and reviewers meet to discuss and assert the readiness of a contribution to a Bitbucket repository comprising code, tests, configuration, or a combination of these.<br/>
<br/>
A person who creates a PR gets attributed as its author and nominates at least one reviewer. Once mandatory changes requested by the reviewers have been incorporated by the contributors, reviewers can approve the PR. An approval permits that the approved contribution can be merged from a temporary source branch into a longer living target branch inside the repository.{{#if metadata.gxp}} A single person must not assume the roles of contributor and reviewer on the same PR (no self-approvals).{{/if}}<br/>
<br/>
Expand Down
2 changes: 1 addition & 1 deletion templates/TIR-infra.html.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@
<div class="page">
<h2 id="section_6"><span>6</span>Reference Documents</h2>
<ul>
<li>Technical Installation Plan ({{metadata.referencedDocs.TIP}})</li></li>
<li>Technical Installation Plan ({{metadata.referencedDocs.TIP}})</li>
</ul>
{{#if data.sections.sec6.show}}
<table class="no-border">
Expand Down
Loading