Skip to content

Commit

Permalink
Add catalog concepts to Catalog Layer and Model in website "Documenta…
Browse files Browse the repository at this point in the history
…tion" section (usnistgov#661)

* Reorganization od documentation section.
* Added lunch with the devs slides from 5/7 and 5/21.
* Fixed a bunch of spelling errors in website content
* Moved control and catalog concepts from "learn more" to "documentation" website section.
* Removed old architecture diagram.
* Refactored the component definition model to be aligned with the SSP model. (usnistgov#584)
* Consolidating catalog layer and model documentation.
* Updated README.txt to reflect the latest milestone 3.
* Reorganized the release-notes.txt to provide a model-based organization structure.
* Moved conceptual definitions to layer pages.
* Updated milestone roadmap.
* Fixed broken links.
* Disabled typography support in Hugo to prevent quotes from being replaced unintentionally.
  • Loading branch information
david-waltermire authored Jun 3, 2020
1 parent d389d40 commit d4398a2
Show file tree
Hide file tree
Showing 45 changed files with 802 additions and 577 deletions.
2 changes: 1 addition & 1 deletion build/ci-cd/generate-specification-documentation.sh
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ if [ "$VERBOSE" = "true" ]; then
fi

SPEC_SOURCE="${OSCALDIR}/src/specifications/profile-resolution/profile-resolution-specml.xml"
SPEC_OUTPUT="$WORKING_DIR/docs/content/documentation/specification/processing/profile-resolution.html"
SPEC_OUTPUT="$WORKING_DIR/docs/content/documentation/processing/profile-resolution.html"

result=$(xsl_transform "$OSCALDIR/src/specifications/profile-resolution/specml-html-hugo-uswds.xsl" "${SPEC_SOURCE}" "${SPEC_OUTPUT}" 2>&1)
cmd_exitcode=$?
Expand Down
2 changes: 2 additions & 0 deletions docs/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ pygmentsCodefencesGuessSyntax: true
pygmentsUseClasses: true
markup:
goldmark:
extensions:
typographer: false
renderer:
unsafe: true
highlight:
Expand Down
2 changes: 1 addition & 1 deletion docs/content/contribute/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ menu:
weight: 10
---

We are excited that you want to contribute to the OSCAL project. We are striving to provide a collaborative environment for professionals to contribute to the project's goals and objectives. A primary focus of this project is to improve security assessment efficiency, accuracy, and consistency on the basis of real-world experience with the technology used in this space. The language we develop must be well-defined, with easy to use formats that improve both the User Experience (UX) and the Machine Experience (MX).
We are excited that you want to contribute to the OSCAL project. We are striving to provide a collaborative environment for professionals to contribute to the project's goals and objectives. A primary focus of this project is to improve security assessment efficiency, accuracy, and consistency on the basis of real-world experience with the technology used in this space. The language we develop must be well-defined, with easy to use formats.

# Contributing

Expand Down
4 changes: 2 additions & 2 deletions docs/content/contribute/dev-lunch/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ sidenav:

Note: (1/10/2020) The Bluejeans info below has changed.

{{% usa-tag %}}Meeting Link{{% /usa-tag %}} https://bluejeans.com/187858571/0183 ([ICS file](../lunch-with-the-devs.ics))
{{% usa-tag %}}Meeting Link{{% /usa-tag %}} https://bluejeans.com/187858571/0183 ([ICS file](lunch-with-the-devs.ics))

{{% usa-tag %}}Meeting Details{{% /usa-tag %}}

Expand All @@ -30,7 +30,7 @@ Participant Passcode: 0183

{{% usa-tag %}}Format{{% /usa-tag %}} Question and Answer, Discussion

Each teleconference will cover the following:
After a brief introduction to the meeting, each teleconference will cover the following:

- The OSCAL team will provide a *short summary* of **what we are currently working on**. (5 to 10 minutes)
- The OSCAL team will **discuss issues** that we need **community feedback** on or **help with**, if we have any for that week. (0 to 10 minutes)
Expand Down
22 changes: 22 additions & 0 deletions docs/content/contribute/dev-lunch/meeting-2020-05-07.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: May 7th, 2020
date: 2020-05-07
summary: Reviewed current status, discussed how to facilitate more model community feedback, and held open discussion.
sidenav:
enabled: false
---

## Slides

- Overview ([PDF](../slides-2020-05-07.pdf))

## Agenda

- Review closed and open pull requests in OSCAL repo.
- Discuss current work.
- Discuss creating a bi-weekly community web conference to support high-bandwidth model feedback and development
- Open discussion.

## Notes

- There is interest in having the model discussion. A Doodle pool will be sent to the [email protected] mailing list to find a good day.
22 changes: 22 additions & 0 deletions docs/content/contribute/dev-lunch/meeting-2020-05-21.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: May 21st, 2020
date: 2020-05-21
summary: Reviewed current status, discussed how to facilitate more model community feedback, and held open discussion.
sidenav:
enabled: false
---

## Slides

- Overview ([PDF](../slides-2020-05-21.pdf))

## Agenda

- Review closed and open pull requests in OSCAL repo.
- Discuss current work.
- Scheduling a bi-weekly community web conference to support high-bandwidth model feedback and development
- Open discussion.

## Notes

- The Doodle pool results show that Fridays @ 10am EDT are the best time to have the model review meeting. The OSCAL team will send out a meeting invite for this time to the [email protected] mailing list.
Binary file not shown.
Binary file not shown.
20 changes: 12 additions & 8 deletions docs/content/contribute/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The first major version of OSCAL, OSCAL v1, will be developed over a series of m

{{<usa-tag>}}Focus{{</usa-tag>}} Development of the OSCAL Catalog and Profile Models.

This initial OSCAL work encompasses the [catalog](/learnmore/architecture/catalog/) and [profile](/learnmore/architecture/profile/) concepts of the OSCAL [architecture](/learnmore/architecture/).
This initial OSCAL work encompasses the [catalog](/documentation/schema/profile-layer/#catalog) and [profile](/documentation/schema/profile-layer/#profile) concepts of the OSCAL architecture.

The following stakeholders can benefit from control catalogs and control baselines defined using the OSCAL catalog and profile models respectively.

Expand All @@ -43,7 +43,7 @@ The following stakeholders can benefit from control catalogs and control baselin

{{<usa-tag>}}Focus{{</usa-tag>}} Development of the OSCAL System Security Plan (SSP) Model.

This next phase of OSCAL work encompasses the SSP concepts that are part of the implementation layer of the OSCAL [architecture](/learnmore/architecture/). Updates to the catalog and profile models are also provided with this release.
In this development phase the system security plan (SSP) model was developed as part of the [implementation layer](/documentation/schema/implementation-layer/) of the OSCAL architecture. Updates to the [catalog](/documentation/schema/catalog-layer/catalog/) and [profile](/documentation/schema/profile-layer/profile/) models are also provided with this release.

The following additional stakeholders can benefit from SSPs formatted based on the OSCAL SSP model.

Expand All @@ -57,11 +57,15 @@ The following additional stakeholders can benefit from SSPs formatted based on t

{{<usa-tag>}}Development Milestone{{</usa-tag>}} OSCAL 1.0.0 [Milestone 3](https://github.com/usnistgov/OSCAL/milestone/3)

{{<usa-tag>}}Status{{</usa-tag>}} [Under development](https://github.com/usnistgov/OSCAL/)
{{<usa-tag>}}Status{{</usa-tag>}} [Released](https://github.com/usnistgov/OSCAL/releases/)

{{<usa-tag>}}Focus{{</usa-tag>}} Development of the OSCAL Component Definition model.
{{<usa-tag>}}Focus{{</usa-tag>}} Development of the OSCAL Component Definition model and drafts of the assessment and assessment result layer models.

This current phase of OSCAL work involves completing development of the OSCAL component definition model that is part of the implementation layer of the OSCAL [architecture](/learnmore/architecture/). Updates to the catalog, profile, and SSP models will also be provided with this release.
This development phase focused on three major areas:

1. The OSCAL [component definition model](/documentation/schema/implementation-layer/component/), which is part of the [implementation layer](/documentation/schema/implementation-layer/) of the OSCAL architecture.
1. Creation of draft models for the [assessment](/documentation/schema/assessment-layer/) and [assessment result](/documentation/schema/assessment-results-layer/) layers. Drafts of the [assessment plan](/documentation/schema/assessment-layer/assessment-plan/), [assessment results](/documentation/schema/assessment-results-layer/assessment-results/), and [plan of action and milestones](/documentation/schema/assessment-results-layer/poam/) (POA&M) models were created.
1. Updates to the [catalog](/documentation/schema/catalog-layer/catalog/), [profile](/documentation/schema/profile-layer/profile/), and [SSP](/documentation/schema/implementation-layer/ssp/) models are also provided with this release.

The following additional stakeholders can benefit from component definitions formatted based on the OSCAL component definitions model. They include the following producers of OSCAL catalogs, profiles, and/or tools:

Expand Down Expand Up @@ -93,8 +97,8 @@ Similar to OSCAL v1, the second major version of OSCAL, OSCAL v2, will be develo

{{<usa-tag>}}Status{{</usa-tag>}} Planned

{{<usa-tag>}}Focus{{</usa-tag>}} Develop the OSCAL Assessment and Assessment Results models.
{{<usa-tag>}}Focus{{</usa-tag>}} Further development of the OSCAL Assessment and Assessment Results models.

The OSCAL Assessment and Assessment Results models will be developed as part of the OSCAL 2.0.0 release. This development will address the Assessment and Assessment Results layers of the OSCAL [architecture](/learnmore/architecture/).
The OSCAL Assessment and Assessment Results layers of the OSCAL architecture will continue to be developed as part of the OSCAL 2.0.0 release. This phase of development will focus on integrating automated means of collecting assessment data using existing assessment technologies.

This assessment work has been split from the earlier OSCAL v1 epic to allow a stable version of OSCAL formats to be released and maintained that provide a solid foundation for publishing control catalog and baseline information, and to allow organizations to automate the documentation and maintenance of system implementations. This will allow tool vendors to develop against stable OSCAL v1 releases, while ongoing development of OSCAL v2 continues.
This assessment development work has been split from the earlier OSCAL v1 epic to allow a stable version of OSCAL formats to be released and maintained that provide a solid foundation for publishing control catalog and baseline information, and to allow organizations to automate the documentation, maintenance, and human-focused assessment of system implementations. This will allow tool vendors to develop against stable OSCAL v1 releases, while ongoing development of OSCAL v2 continues.
22 changes: 17 additions & 5 deletions docs/content/documentation/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,27 @@ menu:
primary:
name: Documentation
weight: 40
suppresstopiclist: false
sidenav:
inactiverenderdepth: 1
activerenderdepth: 2
---

The following documentation for OSCAL is provided:
This section of the OSCAL website provides the specification for OSCAL.

- **Layers and Models:** Documentation for the OSCAL [layers and models](schema/), including descriptions of the XML and JSON formats provided for each model.
- **Processing Specification:** [Specifications](specification/) for processing some types of OSCAL content.
- A detailed description of the [data types](schema/datatypes/) used in the OSCAL models.
- Real-world and constructed examples of the OSCAL models in XML, JSON, and YAML formats.
The OSCAL specification is split into multiple sections:

1. [**Layers and Model Reference**](schema/)

This section of the OSCAL specification will provide you with details on the layers, models, and formats that comprise OSCAL. Concepts for each layer and model are discussed, and the semantics of each model and associated formats are defined.

OSCAL is organized into a a set of related layers. Each layer provides support for control, control implementation, or control assessment concepts. Layers are composed of models, with each model defining an information structure that supports a specific purpose. Each model is bound to a set of XML-, JSON-, and YAML-based formats that allows model-specific OSCAL content to be expressed in a machine-readable structure.

1. [**Processing Documentation**](processing/)

OSCAL defines rules for processing OSCAL content expressed in a format associated with a specific OSCAL model. These rules define how an OSCAL implementation should process and derive information from specific types of OSCAL content.

Additionally, the following other OSCAL documentation is provided:

- Real-world and constructed [examples](examples/) of the OSCAL models in XML, JSON, and YAML formats.
- A discussion of how OSCAL relates to and draws inspiration from [other documentary formats](relations-to-other/).
2 changes: 1 addition & 1 deletion docs/content/documentation/examples.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: OSCAL Content Examples
description: OSCAL Examples
description: Provides information on where to find OSCAL content examples.
aliases:
- /resources/examples/
weight: 90
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: Processing OSCAL
title: Processing Specification
weight: 50
description: Standardized processes to be applied to OSCAL data
aliases:
- /documentation/specification/
---

OSCAL data is intended to be processed in many ways for many different purposes. The specifications here describe normative processes, in the sense that all OSCAL processors that perform these operations should produce the same outputs from the same inputs under the same configuration. However, users and developers should find many ways to take advantage of data encoded in OSCAL, even beyond what is considered here.
2 changes: 1 addition & 1 deletion docs/content/documentation/relations-to-other.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Relations to Documentary Encoding Standards
title: Relations to Other Documentary Encoding Standards
description: Explanation of how OSCAL relates to various documentary standards.
weight: 100
aliases:
Expand Down
Loading

0 comments on commit d4398a2

Please sign in to comment.