Skip to content

Commit

Permalink
adding 1.0.1 documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
david-waltermire committed Jan 30, 2022
1 parent 0892b9d commit c57f001
Show file tree
Hide file tree
Showing 74 changed files with 980,273 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/website-artifacts.yml
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ jobs:
submodules: recursive
token: ${{ secrets.COMMIT_TOKEN }}
- name: Get latest from repo
if: ${{ github.repository == env.HOME_REPO && github.event_name == 'push' }}
if: ${{ github.repository == env.HOME_REPO && github.ref == format('refs/heads/{0}',env.HOME_BRANCH) && github.event_name == 'push' }}
# This will ensure that any files committed by the previous job, will be updated
run: |
git pull --ff-only
Expand Down
17 changes: 17 additions & 0 deletions docs/content/reference/1.0.1/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: "OSCAL v1.0.1 Reference"
summary: "1.0.1"
layout: reference-release
weight: 70
sidenav:
title: 1.0.1
focusrenderdepth: 1
activerenderdepth: -1
inactiverenderdepth: 1
debug: false
oscal:
type: "tag"
branch: "v1.0.1"
revision: "1.0.1"
version: "1.0.1"
---
22 changes: 22 additions & 0 deletions docs/content/reference/1.0.1/assessment-plan/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: "Assessment Plan Model v1.0.1 Reference"
summary: "Assessment Plan Model"
weight: 20
suppresstopiclist: true
sidenav:
title: Assessment Plan Model
focusrenderdepth: 1
activerenderdepth: -1
inactiverenderdepth: 1
---

<p><span class="usa-tag">Release Version</span> OSCAL v1.0.1</p>
<p><span class="usa-tag">Github</span> <a href="https://github.com/usnistgov/OSCAL">usnistgov/OSCAL</a> <span class="usa-tag">Tag</span> <a href="https://github.com/usnistgov/OSCAL/tree/v1.0.1">v1.0.1</a></p>

The following reference documentation is available for the OSCAL Assessment Plan model.

- **[Conceptual Overview](/concepts/layer/assessment/assessment-plan/):** Provides a high-level overview of the model's intended purpose and role in the [OSCAL architecture](/concepts/layer/). Describes the model's purpose, target audience, and key concepts.
- **Outline ([JSON/YAML](json-outline/), [XML](xml-outline/)):** Provides a brief listing of the model's information items organized hierarchically. Useful for understanding the structure and basic syntax of the model in a given format.
- **Reference ([JSON/YAML](json-reference/), [XML](xml-reference/)):** Provides a detailed description of the structure and syntax for the model's information items organized hierarchically. Useful for understanding how to use information items within the model in the given format.
- **Index ([JSON/YAML](json-index/), [XML](xml-index/)):** Provides a listing of the model's information items organized by where they are used.
- **Definitions ([JSON/YAML](json-definitions/), [XML](xml-definitions/)):** Provides a reference for the XML Schema types and JSON Schema definitions derived from this model's [metaschema](https://github.com/usnistgov/OSCAL/blob/v1.0.1/src/metaschema/oscal_assessment-plan). A metaschema is used to [express the model](/concepts/layer/overview/#modeling-approach) in a format agnostic way, that is then used to generate the XML and JSON Schema, XML <-> JSON content converters, and this reference documentation.
12,115 changes: 12,115 additions & 0 deletions docs/content/reference/1.0.1/assessment-plan/json-definitions.md

Large diffs are not rendered by default.

1,502 changes: 1,502 additions & 0 deletions docs/content/reference/1.0.1/assessment-plan/json-index.md

Large diffs are not rendered by default.

4,626 changes: 4,626 additions & 0 deletions docs/content/reference/1.0.1/assessment-plan/json-outline.md

Large diffs are not rendered by default.

21,665 changes: 21,665 additions & 0 deletions docs/content/reference/1.0.1/assessment-plan/json-reference.md

Large diffs are not rendered by default.

12,092 changes: 12,092 additions & 0 deletions docs/content/reference/1.0.1/assessment-plan/xml-definitions.md

Large diffs are not rendered by default.

1,489 changes: 1,489 additions & 0 deletions docs/content/reference/1.0.1/assessment-plan/xml-index.md

Large diffs are not rendered by default.

3,065 changes: 3,065 additions & 0 deletions docs/content/reference/1.0.1/assessment-plan/xml-outline.md

Large diffs are not rendered by default.

22,692 changes: 22,692 additions & 0 deletions docs/content/reference/1.0.1/assessment-plan/xml-reference.md

Large diffs are not rendered by default.

22 changes: 22 additions & 0 deletions docs/content/reference/1.0.1/assessment-results/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: "Assessment Results Model v1.0.1 Reference"
summary: "Assessment Results Model"
weight: 20
suppresstopiclist: true
sidenav:
title: Assessment Results Model
focusrenderdepth: 1
activerenderdepth: -1
inactiverenderdepth: 1
---

<p><span class="usa-tag">Release Version</span> OSCAL v1.0.1</p>
<p><span class="usa-tag">Github</span> <a href="https://github.com/usnistgov/OSCAL">usnistgov/OSCAL</a> <span class="usa-tag">Tag</span> <a href="https://github.com/usnistgov/OSCAL/tree/v1.0.1">v1.0.1</a></p>

The following reference documentation is available for the OSCAL Assessment Results model.

- **[Conceptual Overview](/concepts/layer/assessment/assessment-results/):** Provides a high-level overview of the model's intended purpose and role in the [OSCAL architecture](/concepts/layer/). Describes the model's purpose, target audience, and key concepts.
- **Outline ([JSON/YAML](json-outline/), [XML](xml-outline/)):** Provides a brief listing of the model's information items organized hierarchically. Useful for understanding the structure and basic syntax of the model in a given format.
- **Reference ([JSON/YAML](json-reference/), [XML](xml-reference/)):** Provides a detailed description of the structure and syntax for the model's information items organized hierarchically. Useful for understanding how to use information items within the model in the given format.
- **Index ([JSON/YAML](json-index/), [XML](xml-index/)):** Provides a listing of the model's information items organized by where they are used.
- **Definitions ([JSON/YAML](json-definitions/), [XML](xml-definitions/)):** Provides a reference for the XML Schema types and JSON Schema definitions derived from this model's [metaschema](https://github.com/usnistgov/OSCAL/blob/v1.0.1/src/metaschema/oscal_assessment-results). A metaschema is used to [express the model](/concepts/layer/overview/#modeling-approach) in a format agnostic way, that is then used to generate the XML and JSON Schema, XML <-> JSON content converters, and this reference documentation.
Loading

0 comments on commit c57f001

Please sign in to comment.