Skip to content

Commit

Permalink
Fix broken uri-use page links in updated reference docs of develop br…
Browse files Browse the repository at this point in the history
…anch (#1518)

* Fix documentation relative paths in Metaschema

Recently added links in documentation refer to href="/OSCAL" and not
href="https://pages.nist.gov/OSCAL" in error or to simplify link gen
and lookup. Now that we are remapping the full URLs to local paths and
offsets for link-checking, we want these to be consistent across the
board in Metaschema after #1263.

* Pushing generated website pages manual override [ci skip].

* Restore rel paths for develop branch ref model docs and fix link checks.

* Test full URLs per @dave-waltermire-nist's PR feedback.
  • Loading branch information
aj-stein-nist committed Jul 10, 2023
1 parent f3371cc commit a332ff0
Show file tree
Hide file tree
Showing 18 changed files with 100 additions and 100 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/workflow-generate-website.yml
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ jobs:
id: linkchecker
uses: lycheeverse/lychee-action@4a5af7cd2958a2282cefbd9c10f63bdb89982d76
with:
args: --exclude-file ./build/config/.lycheeignore --verbose --no-progress './docs/public/**/*.html' --accept 200,206,429
args: --exclude-file ./build/config/.lycheeignore --verbose --no-progress --accept 200,206,429 './docs/public/**/*.html' --remap "https://pages.nist.gov/OSCAL/ file://${GITHUB_WORKSPACE}/docs/public/" --exclude-mail
format: markdown
output: html-link-report.md
env:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/workflow-validate-website-content.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ jobs:
id: linkchecker
uses: lycheeverse/lychee-action@4a5af7cd2958a2282cefbd9c10f63bdb89982d76
with:
args: --exclude-file ./build/config/.lycheeignore --verbose --no-progress --accept 200,206,429 './published/**/*.html' --exclude-mail
args: --exclude-file ./build/config/.lycheeignore --verbose --no-progress --accept 200,206,429 "./${INPUT_SITE_GIT_REF}/**/*.html" --remap "https://pages.nist.gov/OSCAL/ file://${GITHUB_WORKSPACE}/${INPUT_SITE_GIT_REF}/" --exclude-mail
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Create issue if bad links detected
Expand Down
4 changes: 2 additions & 2 deletions docs/content/reference/develop/assessment-plan/xml-outline.md
Original file line number Diff line number Diff line change
Expand Up @@ -1093,7 +1093,7 @@ The following outline is a representation of the [XML format](https://github.com
<p class="OM-line"><span class="sq"><span class="nobr">&lt;<a class="OM-name" href="../xml-reference/#/assessment-plan/local-definitions/objectives-and-methods/part/part">part</a></span>&gt;<span class="show-closed"><span class="OM-lit OM-gloss"> (recursive: model like parent <span class="OM-ref">part</span>) </span><span class="nobr">&lt;/part&gt;</span></span></span><span class="sq cardinality"> <span class="OM-cardinality">[0 to ∞]</span></span></p>
</div>
<details class="OM-entry">
<summary><span class="sq"><span class="nobr">&lt;<a class="OM-name" href="../xml-reference/#/assessment-plan/local-definitions/objectives-and-methods/part/link">link</a></span> <span class="nobr" id="/assessment-plan/local-definitions/objectives-and-methods/part/link/@href"><a class="OM-name" href="../xml-reference/#/assessment-plan/local-definitions/objectives-and-methods/part/link/@href">href</a>="<span class="OM-datatype"><a href="/reference/datatypes/#uri-reference">uri-reference</a></span>"</span> <span class="nobr" id="/assessment-plan/local-definitions/objectives-and-methods/part/link/@rel"><a class="OM-name" href="../xml-reference/#/assessment-plan/local-definitions/objectives-and-methods/part/link/@rel">rel</a>="<span class="OM-datatype"><a href="/reference/datatypes/#token">token</a></span>"</span> <span class="nobr" id="/assessment-plan/local-definitions/objectives-and-methods/part/link/@media-type"><a class="OM-name" href="../xml-reference/#/assessment-plan/local-definitions/objectives-and-methods/part/link/@media-type">media-type</a>="<span class="OM-datatype"><a href="/reference/datatypes/#string">string</a></span>"</span> <span class="nobr" id="/assessment-plan/local-definitions/objectives-and-methods/part/link/@resource-fragment"><a class="OM-name" href="../xml-reference/#/assessment-plan/local-definitions/objectives-and-methods/part/link/@resource-fragment">resource-fragment</a>="<span class="OM-datatype"><a href="/reference/datatypes/#string">string</a></span>"</span>&gt;<span class="show-closed"> … <span class="nobr">&lt;/link&gt;</span></span></span><span class="sq cardinality"> <span class="OM-cardinality">[0 to ∞]</span></span></summary>
<summary><span class="sq"><span class="nobr">&lt;<a class="OM-name" href="../xml-reference/#/assessment-plan/local-definitions/objectives-and-methods/part/link">link</a></span> <span class="nobr" id="/assessment-plan/local-definitions/objectives-and-methods/part/link/@href"><a class="OM-name" href="../xml-reference/#/assessment-plan/local-definitions/objectives-and-methods/part/link/@href">href</a>="<span class="OM-datatype"><a href="/reference/datatypes/#uri-reference">uri-reference</a></span>"</span> <span class="nobr" id="/assessment-plan/local-definitions/objectives-and-methods/part/link/@rel"><a class="OM-name" href="../xml-reference/#/assessment-plan/local-definitions/objectives-and-methods/part/link/@rel">rel</a>="<span class="OM-datatype"><a href="/reference/datatypes/#token">token</a></span>"</span> <span class="nobr" id="/assessment-plan/local-definitions/objectives-and-methods/part/link/@media-type"><a class="OM-name" href="../xml-reference/#/assessment-plan/local-definitions/objectives-and-methods/part/link/@media-type">media-type</a>="<span class="OM-datatype"><a href="/reference/datatypes/#string">string</a></span>"</span>&gt;<span class="show-closed"> … <span class="nobr">&lt;/link&gt;</span></span></span><span class="sq cardinality"> <span class="OM-cardinality">[0 to ∞]</span></span></summary>
<div class="model-container">
<details class="OM-entry">
<summary><span class="sq"><span class="nobr">&lt;<a class="OM-name" href="../xml-reference/#/assessment-plan/local-definitions/objectives-and-methods/part/link/text">text</a></span>&gt;<span class="show-closed"><span class="OM-datatype"><a href="/reference/datatypes/#markup-line">markup-line</a></span><span class="nobr">&lt;/text&gt;</span></span></span><span class="sq cardinality"> <span class="OM-cardinality">[0 or 1]</span></span></summary>
Expand Down Expand Up @@ -1780,7 +1780,7 @@ The following outline is a representation of the [XML format](https://github.com
<p class="OM-line"><span class="sq"><span class="nobr">&lt;<a class="OM-name" href="../xml-reference/#/assessment-plan/terms-and-conditions/part/part">part</a></span>&gt;<span class="show-closed"><span class="OM-lit OM-gloss"> (recursive: model like parent <span class="OM-ref">part</span>) </span><span class="nobr">&lt;/part&gt;</span></span></span><span class="sq cardinality"> <span class="OM-cardinality">[0 to ∞]</span></span></p>
</div>
<details class="OM-entry">
<summary><span class="sq"><span class="nobr">&lt;<a class="OM-name" href="../xml-reference/#/assessment-plan/terms-and-conditions/part/link">link</a></span> <span class="nobr" id="/assessment-plan/terms-and-conditions/part/link/@href"><a class="OM-name" href="../xml-reference/#/assessment-plan/terms-and-conditions/part/link/@href">href</a>="<span class="OM-datatype"><a href="/reference/datatypes/#uri-reference">uri-reference</a></span>"</span> <span class="nobr" id="/assessment-plan/terms-and-conditions/part/link/@rel"><a class="OM-name" href="../xml-reference/#/assessment-plan/terms-and-conditions/part/link/@rel">rel</a>="<span class="OM-datatype"><a href="/reference/datatypes/#token">token</a></span>"</span> <span class="nobr" id="/assessment-plan/terms-and-conditions/part/link/@media-type"><a class="OM-name" href="../xml-reference/#/assessment-plan/terms-and-conditions/part/link/@media-type">media-type</a>="<span class="OM-datatype"><a href="/reference/datatypes/#string">string</a></span>"</span> <span class="nobr" id="/assessment-plan/terms-and-conditions/part/link/@resource-fragment"><a class="OM-name" href="../xml-reference/#/assessment-plan/terms-and-conditions/part/link/@resource-fragment">resource-fragment</a>="<span class="OM-datatype"><a href="/reference/datatypes/#string">string</a></span>"</span>&gt;<span class="show-closed"> … <span class="nobr">&lt;/link&gt;</span></span></span><span class="sq cardinality"> <span class="OM-cardinality">[0 to ∞]</span></span></summary>
<summary><span class="sq"><span class="nobr">&lt;<a class="OM-name" href="../xml-reference/#/assessment-plan/terms-and-conditions/part/link">link</a></span> <span class="nobr" id="/assessment-plan/terms-and-conditions/part/link/@href"><a class="OM-name" href="../xml-reference/#/assessment-plan/terms-and-conditions/part/link/@href">href</a>="<span class="OM-datatype"><a href="/reference/datatypes/#uri-reference">uri-reference</a></span>"</span> <span class="nobr" id="/assessment-plan/terms-and-conditions/part/link/@rel"><a class="OM-name" href="../xml-reference/#/assessment-plan/terms-and-conditions/part/link/@rel">rel</a>="<span class="OM-datatype"><a href="/reference/datatypes/#token">token</a></span>"</span> <span class="nobr" id="/assessment-plan/terms-and-conditions/part/link/@media-type"><a class="OM-name" href="../xml-reference/#/assessment-plan/terms-and-conditions/part/link/@media-type">media-type</a>="<span class="OM-datatype"><a href="/reference/datatypes/#string">string</a></span>"</span>&gt;<span class="show-closed"> … <span class="nobr">&lt;/link&gt;</span></span></span><span class="sq cardinality"> <span class="OM-cardinality">[0 to ∞]</span></span></summary>
<div class="model-container">
<details class="OM-entry">
<summary><span class="sq"><span class="nobr">&lt;<a class="OM-name" href="../xml-reference/#/assessment-plan/terms-and-conditions/part/link/text">text</a></span>&gt;<span class="show-closed"><span class="OM-datatype"><a href="/reference/datatypes/#markup-line">markup-line</a></span><span class="nobr">&lt;/text&gt;</span></span></span><span class="sq cardinality"> <span class="OM-cardinality">[0 or 1]</span></span></summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -667,7 +667,7 @@ The following outline is a representation of the [XML format](https://github.com
<p class="OM-line"><span class="sq"><span class="nobr">&lt;<a class="OM-name" href="../xml-reference/#/assessment-results/local-definitions/objectives-and-methods/part/part">part</a></span>&gt;<span class="show-closed"><span class="OM-lit OM-gloss"> (recursive: model like parent <span class="OM-ref">part</span>) </span><span class="nobr">&lt;/part&gt;</span></span></span><span class="sq cardinality"> <span class="OM-cardinality">[0 to ∞]</span></span></p>
</div>
<details class="OM-entry">
<summary><span class="sq"><span class="nobr">&lt;<a class="OM-name" href="../xml-reference/#/assessment-results/local-definitions/objectives-and-methods/part/link">link</a></span> <span class="nobr" id="/assessment-results/local-definitions/objectives-and-methods/part/link/@href"><a class="OM-name" href="../xml-reference/#/assessment-results/local-definitions/objectives-and-methods/part/link/@href">href</a>="<span class="OM-datatype"><a href="/reference/datatypes/#uri-reference">uri-reference</a></span>"</span> <span class="nobr" id="/assessment-results/local-definitions/objectives-and-methods/part/link/@rel"><a class="OM-name" href="../xml-reference/#/assessment-results/local-definitions/objectives-and-methods/part/link/@rel">rel</a>="<span class="OM-datatype"><a href="/reference/datatypes/#token">token</a></span>"</span> <span class="nobr" id="/assessment-results/local-definitions/objectives-and-methods/part/link/@media-type"><a class="OM-name" href="../xml-reference/#/assessment-results/local-definitions/objectives-and-methods/part/link/@media-type">media-type</a>="<span class="OM-datatype"><a href="/reference/datatypes/#string">string</a></span>"</span> <span class="nobr" id="/assessment-results/local-definitions/objectives-and-methods/part/link/@resource-fragment"><a class="OM-name" href="../xml-reference/#/assessment-results/local-definitions/objectives-and-methods/part/link/@resource-fragment">resource-fragment</a>="<span class="OM-datatype"><a href="/reference/datatypes/#string">string</a></span>"</span>&gt;<span class="show-closed"> … <span class="nobr">&lt;/link&gt;</span></span></span><span class="sq cardinality"> <span class="OM-cardinality">[0 to ∞]</span></span></summary>
<summary><span class="sq"><span class="nobr">&lt;<a class="OM-name" href="../xml-reference/#/assessment-results/local-definitions/objectives-and-methods/part/link">link</a></span> <span class="nobr" id="/assessment-results/local-definitions/objectives-and-methods/part/link/@href"><a class="OM-name" href="../xml-reference/#/assessment-results/local-definitions/objectives-and-methods/part/link/@href">href</a>="<span class="OM-datatype"><a href="/reference/datatypes/#uri-reference">uri-reference</a></span>"</span> <span class="nobr" id="/assessment-results/local-definitions/objectives-and-methods/part/link/@rel"><a class="OM-name" href="../xml-reference/#/assessment-results/local-definitions/objectives-and-methods/part/link/@rel">rel</a>="<span class="OM-datatype"><a href="/reference/datatypes/#token">token</a></span>"</span> <span class="nobr" id="/assessment-results/local-definitions/objectives-and-methods/part/link/@media-type"><a class="OM-name" href="../xml-reference/#/assessment-results/local-definitions/objectives-and-methods/part/link/@media-type">media-type</a>="<span class="OM-datatype"><a href="/reference/datatypes/#string">string</a></span>"</span>&gt;<span class="show-closed"> … <span class="nobr">&lt;/link&gt;</span></span></span><span class="sq cardinality"> <span class="OM-cardinality">[0 to ∞]</span></span></summary>
<div class="model-container">
<details class="OM-entry">
<summary><span class="sq"><span class="nobr">&lt;<a class="OM-name" href="../xml-reference/#/assessment-results/local-definitions/objectives-and-methods/part/link/text">text</a></span>&gt;<span class="show-closed"><span class="OM-datatype"><a href="/reference/datatypes/#markup-line">markup-line</a></span><span class="nobr">&lt;/text&gt;</span></span></span><span class="sq cardinality"> <span class="OM-cardinality">[0 or 1]</span></span></summary>
Expand Down Expand Up @@ -2909,7 +2909,7 @@ The following outline is a representation of the [XML format](https://github.com
<p class="OM-line"><span class="sq"><span class="nobr">&lt;<a class="OM-name" href="../xml-reference/#/assessment-results/result/attestation/part/part">part</a></span>&gt;<span class="show-closed"><span class="OM-lit OM-gloss"> (recursive: model like parent <span class="OM-ref">part</span>) </span><span class="nobr">&lt;/part&gt;</span></span></span><span class="sq cardinality"> <span class="OM-cardinality">[0 to ∞]</span></span></p>
</div>
<details class="OM-entry">
<summary><span class="sq"><span class="nobr">&lt;<a class="OM-name" href="../xml-reference/#/assessment-results/result/attestation/part/link">link</a></span> <span class="nobr" id="/assessment-results/result/attestation/part/link/@href"><a class="OM-name" href="../xml-reference/#/assessment-results/result/attestation/part/link/@href">href</a>="<span class="OM-datatype"><a href="/reference/datatypes/#uri-reference">uri-reference</a></span>"</span> <span class="nobr" id="/assessment-results/result/attestation/part/link/@rel"><a class="OM-name" href="../xml-reference/#/assessment-results/result/attestation/part/link/@rel">rel</a>="<span class="OM-datatype"><a href="/reference/datatypes/#token">token</a></span>"</span> <span class="nobr" id="/assessment-results/result/attestation/part/link/@media-type"><a class="OM-name" href="../xml-reference/#/assessment-results/result/attestation/part/link/@media-type">media-type</a>="<span class="OM-datatype"><a href="/reference/datatypes/#string">string</a></span>"</span> <span class="nobr" id="/assessment-results/result/attestation/part/link/@resource-fragment"><a class="OM-name" href="../xml-reference/#/assessment-results/result/attestation/part/link/@resource-fragment">resource-fragment</a>="<span class="OM-datatype"><a href="/reference/datatypes/#string">string</a></span>"</span>&gt;<span class="show-closed"> … <span class="nobr">&lt;/link&gt;</span></span></span><span class="sq cardinality"> <span class="OM-cardinality">[0 to ∞]</span></span></summary>
<summary><span class="sq"><span class="nobr">&lt;<a class="OM-name" href="../xml-reference/#/assessment-results/result/attestation/part/link">link</a></span> <span class="nobr" id="/assessment-results/result/attestation/part/link/@href"><a class="OM-name" href="../xml-reference/#/assessment-results/result/attestation/part/link/@href">href</a>="<span class="OM-datatype"><a href="/reference/datatypes/#uri-reference">uri-reference</a></span>"</span> <span class="nobr" id="/assessment-results/result/attestation/part/link/@rel"><a class="OM-name" href="../xml-reference/#/assessment-results/result/attestation/part/link/@rel">rel</a>="<span class="OM-datatype"><a href="/reference/datatypes/#token">token</a></span>"</span> <span class="nobr" id="/assessment-results/result/attestation/part/link/@media-type"><a class="OM-name" href="../xml-reference/#/assessment-results/result/attestation/part/link/@media-type">media-type</a>="<span class="OM-datatype"><a href="/reference/datatypes/#string">string</a></span>"</span>&gt;<span class="show-closed"> … <span class="nobr">&lt;/link&gt;</span></span></span><span class="sq cardinality"> <span class="OM-cardinality">[0 to ∞]</span></span></summary>
<div class="model-container">
<details class="OM-entry">
<summary><span class="sq"><span class="nobr">&lt;<a class="OM-name" href="../xml-reference/#/assessment-results/result/attestation/part/link/text">text</a></span>&gt;<span class="show-closed"><span class="OM-datatype"><a href="/reference/datatypes/#markup-line">markup-line</a></span><span class="nobr">&lt;/text&gt;</span></span></span><span class="sq cardinality"> <span class="OM-cardinality">[0 or 1]</span></span></summary>
Expand Down
Loading

0 comments on commit a332ff0

Please sign in to comment.