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.

Sign up for GitHub

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

Update QM appendices #253

Merged
merged 6 commits into from
Sep 19, 2019
+15 −144
Merged

Update QM appendices #253

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
940e839
:wastebasket: Remove Change History
berezovskyi Sep 19, 2019
5d92cf5
📜 🏃 :label: Merge A.2 into §2.2 Spec Versioning
berezovskyi Sep 19, 2019
cd0834f
:paperclip: :wastebasket: remove CM deprecation appendix
berezovskyi Sep 19, 2019
e4dc741
📜📎 Restore MUST for Query support from v2.0
berezovskyi Sep 19, 2019
234d0cb
Remove Query MUST from the table of differences
berezovskyi Sep 19, 2019
358a02d
:paperclip: Use cite tags
berezovskyi Sep 19, 2019
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
159 changes: 15 additions & 144 deletions specs/qm/quality-management-spec.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,17 @@
],

relatedWork: [
{
title: "OSLC Quality Management Specification Version 2.0",
href: "https://archive.open-services.net/bin/view/Main/QmSpecificationV2.html"
}
],


localBiblio: {
"OSLCQM2": {
title: "OSLC Quality Management Specification Version 2.0",
href: "https://archive.open-services.net/bin/view/Main/QmSpecificationV2.html",
authors: ["Paul McMahan"],
status: "Finalized",
publisher: "http://open-services.net",
},
"OSLCCore2": {
title: "OSLC Core Specification 2.0",
href: "https://archive.open-services.net/bin/view/Main/OslcCoreSpecification",
Expand Down Expand Up @@ -296,7 +299,7 @@ <h2>Base Requirements</h2>
SHOULD follow all the guidelines and recommendations in both these
specifications.</p>

<p class="conformance">An OSLC QM server MUST implement the domain vocabulary defined in <a href="https://docs.oasis-open-projects.org/oslc-op/qm/v2.1/quality-management-vocab.html">OSLC Quality Management Version 2.1. Part 2: Vocabulary</a>
<p class="conformance">An OSLC QM server MUST implement the domain vocabulary defined in <a href="quality-management-vocab.html">OSLC Quality Management Version 2.1. Part 2: Vocabulary</a>

<p>The following table summarizes the requirements from OSLC Core Specification
as well as some additional requirements specific to the QM domain. Note that
Expand Down Expand Up @@ -343,7 +346,7 @@ <h2>Base Requirements</h2>
</tr>
<tr>
<td>Query Capabilities</td>
<td class='conformance'>OSLC servers SHOULD provide query capabilities to enable clients to query for resources</td>
<td class='conformance'>OSLC servers MUST provide query capabilities to enable clients to query for resources</td>
</tr>
<tr>
<td>Query Syntax</td>
Expand Down Expand Up @@ -396,7 +399,12 @@ <h2>Base Requirements</h2>
<section id="versioning">
<h2 id="specificationversioningspec_versioning">Specification Versioning</h2>

<p>This specification follows the specification version guidelines given in [[!OSLCCore3]].</p>
<p>This specification follows the specification version guidelines given in
<cite><a href="http://docs.oasis-open.org/oslc-core/oslc-core/v3.0/oslc-core-v3.0-part1-overview.html#versionCompatibility">
OSLC Core Version 3.0. Part 1: Overview</a></cite>&nbsp;([[!OSLCCore3]], section 5). There are no substantive changes from
<cite><a href="https://archive.open-services.net/bin/view/Main/QmSpecificationV2.html">OSLC Quality Management Specification
Version 2.0</a></cite>&nbsp;[[OSLCQM2]]. All changes are all upward compatible additions and do not introduce
incompatibilities with Version 2.0.</p>
</section>

<section id="namespaces">
Expand Down Expand Up @@ -640,84 +648,6 @@ <h3>Delegated UIs</h3>
<section id="versionCompability" class="appendix">
<h2>Version Compatibility with 2.0 Specifications</h2>

<section id="deprecatedTerms">
<h3 id="deprecatedterms">Deprecated terms</h3>

<p>A number of terms introduced in early development of the OSLC QM domain that were deprecated in the finalized V2.0. These terms are summarized here in order to indicate they remain deprecated.</p>

<table border="1" cellspacing="0" cellpadding="5">
<thead>
<tr>
<th><strong>Prefixed Name</strong></th>
<th><strong>Occurs</strong></th>
<th><strong>Read-only</strong></th>
<th><strong>Value-type</strong></th>
<th><strong>Represen-tation</strong></th>
<th><strong>Range</strong></th>
<th><strong>Description</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td><em>deprecated</em> dcterms:type</td>
<td>zero-or-more</td>
<td>unspecified</td>
<td>String</td>
<td>n/a</td>
<td>n/a</td>
<td>A short string representation for the type, example <code>Defect</code>.</td>
</tr>
<tr>
<td><strong>Relationship properties:</strong> This grouping of properties are used to identify relationships between resources managed by other OSLC servers</td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<td><em>deprecated</em> oslc_cm:testedByTestCase</td>
<td>zero-or-many</td>
<td>False</td>
<td>Resource</td>
<td>Reference</td>
<td>any</td>
<td>Test case by which this Change Request is tested. It is likely that the target resource will be an oslc_qm:TestCase, but that is not necessarily the case.</td>
</tr>
<tr>
<td><em>deprecated</em> oslc_cm:affectsTestResult</td>
<td>zero-or-many</td>
<td>False</td>
<td>Resource</td>
<td>Reference</td>
<td>any</td>
<td>Associated QM resource that is affected by this Change Request. It is likely that the target resource will be an oslc_qm:TestResult, but that is not necessarily the case.</td>
<td><code style="white-space: pre;"></code></td>
<td></td>
</tr>
<tr>
<td><em>deprecated</em> oslc_cm:blocksTestExecutionRecord</td>
<td>zero-or-many</td>
<td>False</td>
<td>Resource</td>
<td>Reference</td>
<td>any</td>
<td>Associated QM resource that is blocked by this Change Request. It is likely that the target resource will be an oslc_cm:TestExecutionRecord, but that is not necessarily the case.</td>
<td><code style="white-space: pre;"></code></td>
<td></td>
</tr>
</tbody>
</table>
</section>

<section id="changesFrom2">
<h2>Changes from Version 2.0</h2>
<p>There are no substantive changes from OSLC QM Specification 2.0. This document is a document maintenance update of the version 2.0 document to support migration from open-services.net to OASIS.The changes are all upward compatible additions and therefore do not introduce incompatibilities with version 2.0.</p>
</section>
</section>

<section id="notesFrom2">
<h2>Observations in migration from Version 2.0</h2>
<p>The following differences where noted when migrating the open-services.net verion 2.0 Quality Management specification to the version 2.1 OASIS template based upon Change Management</p>
<table border=1 cellspacing=0 cellpadding=0>
<tr>
Expand All @@ -736,12 +666,6 @@ <h2>Observations in migration from Version 2.0</h2>
<td>These requirements appear to be hosted under the heading of Discovery</td>
<td>No action</td>
</tr>
<tr>
<td>02</td>
<td>Query capability is MUST</td>
<td>Query capability is SHOULD</td>
<td>No action</td>
</tr>
<tr>
<td>03</td>
<td>Query MUST scope limited to oslc.where and oslc.select</td>
Expand Down Expand Up @@ -787,58 +711,5 @@ <h2>Acknowledgements</h2>
Scott Bosworth (IBM)<br>
Scott Fairbrother (IBM)<br>
</section>


<section class="appendix informative" id="history">
<h2>Change History</h2>

<table border=1 cellspacing=0 cellpadding=0>
<tr>
<td width=103 valign=top style='width:77.4pt;border:solid windowtext 1.0pt;
padding:0in 5.4pt 0in 5.4pt'><b>Revision</b></td>
<td width=96 valign=top style='width:1.0in;border:solid windowtext 1.0pt;
border-left:none;padding:0in 5.4pt 0in 5.4pt'><b>Date</b></td>
<td width=144 valign=top style='width:1.5in;border:solid windowtext 1.0pt;
border-left:none;padding:0in 5.4pt 0in 5.4pt'><b>Editor</b></td>
<td width=295 valign=top style='width:221.4pt;border:solid windowtext 1.0pt;
border-left:none;padding:0in 5.4pt 0in 5.4pt'><b>Changes Made</b></td>
</tr>
<tr>
<td>01</td>
<td>06/10/2017</td>
<td>Gray Bachelor</td>
<td>Initial migration version.</td>
</tr>
<tr>
<td>02</td>
<td>26/12/2017</td>
<td>Gray Bachelor</td>
<td>Next edits towards migration version.</td>
<tr>
<td>03</td>
<td>28/06/2018</td>
<td>Gray Bachelor</td>
<td>Align with released CM 3.0.</td>
</tr>
<tr>
<td>04</td>
<td>27/07/2018</td>
<td>Gray Bachelor</td>
<td>Align with RM and Asset 2.1.</td>
/tr>
<tr>
<td>05</td>
<td>08/08/2018</td>
<td>Gray Bachelor</td>
<td>Check and fix some V2.1 labelling</td>
</tr>
<tr>
<td>06</td>
<td>2019-09-19</td>
<td>Andrew Berezovskyi</td>
<td>Prepare the QM 2.0 PSD 02 for publication</td>
</tr>
</table>
</section>
</body>
</html>