Skip to content

Commit

Permalink
Added New Examples Page, Issue: #1294 (#1675)
Browse files Browse the repository at this point in the history
* added new examples page

* Update docs/content/examples/_index.md

Committing AJ's suggested change.

Co-authored-by: A.J. Stein <alexander.stein@nist.gov>

---------

Co-authored-by: A.J. Stein <alexander.stein@nist.gov>
  • Loading branch information
Arminta-Jenkins-NIST and aj-stein-nist authored Mar 1, 2023
1 parent cbeff74 commit f87dcb1
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/content/examples/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Examples
heading: OSCAL Examples
menu:
primary:
name: Examples
weight: 50
toc:
enabled: true
---

To facilitate the OSCAL adoption in ways that allow the adopters to take full advange of OSCAL abilities of representing the security data and the automation of the security assessment and of the risk management with a maximum return on investment (ROI), the NIST OSCAL team published basic examples of OSCAL content instances in the NIST's OSCAL-content repository, the [examples](https://github.com/usnistgov/oscal-content/tree/main/examples) directory.

To properly understand the examples, interested parties are advised to also review the [OSCAL walkthrough tutorials](https://pages.nist.gov/OSCAL/learn/tutorials).

{{% callout note %}} More OSCAL examples supporting the use of the OSCAL models are developed and maintained by the community in the [OSCAL Club examples repository](https://github.com/oscal-club/examples) .{{% /callout %}}


### Validation

OSCAL examples need to always be formally *validated* to confirm their correctness and fitness for a risk management process and security automation. See [Well-formed Data Formats and Valid OSCAL](https://pages.nist.gov/OSCAL/concepts/layer/validation/) and [Validation of any OSCAL content instance](https://pages.nist.gov/OSCAL/tools/#validation) for more details on how to accomplish OSCAL content instance validation by applying the appropriate schema for the respective format.


0 comments on commit f87dcb1

Please sign in to comment.