diff --git a/.gitignore b/.gitignore index 3f10c81e6d..7739755c09 100644 --- a/.gitignore +++ b/.gitignore @@ -37,13 +37,8 @@ target/ /.runbuild # Generated by scripts .metaschema-cache -# generated by /build/ci-cd/generate-content-converters.sh and /build/ci-cd/generate-schema.sh -#/xml -#/json # generated by /build/metaschema/unit-testing/run-tests.sh /metaschema/unit-testing -# generated by /build/ci-cd/copy-and-convert-content.sh -/content # generated by /build/ci-cd/generate-model-documentation.sh /docs/layouts/partials/generated # generated by Hugo @@ -53,13 +48,11 @@ target/ /docs/node_modules # generated by /build/ci-cd/generate-specification-documentation.sh /docs/content/documentation/processing/profile-resolution.html -# but allow markdown files -!/content/**/*.md -!/xml/*.md -!/xml/**/*.md -!/json/*.md -!/json/**/*.md + # node_modules/ + +# Files build by CI/CD /docs/content/documentation/specification/processing/profile-resolution.html +/docs/scratch-dir diff --git a/docs/assets/scss/hugo-uswds-theme.scss b/docs/assets/scss/hugo-uswds-theme.scss index faa9c4e8d0..20fb0d9481 100644 --- a/docs/assets/scss/hugo-uswds-theme.scss +++ b/docs/assets/scss/hugo-uswds-theme.scss @@ -1,5 +1,7 @@ +/* $theme-site-max-width: 'widescreen'; $theme-grid-container-max-width: 'widescreen'; $theme-banner-max-width: 'widescreen'; $theme-header-max-width: 'widescreen'; $theme-text-measure: 'none'; +*/ \ No newline at end of file diff --git a/docs/content/contact/_index.md b/docs/content/contact/_index.md index 528ae943fc..15ca83a52e 100644 --- a/docs/content/contact/_index.md +++ b/docs/content/contact/_index.md @@ -10,6 +10,8 @@ menu: name: Contact Us url: /contact/ weight: 50 +toc: + enabled: true aliases: - /contribute/contact/ --- diff --git a/docs/content/contribute/_index.md b/docs/content/contribute/_index.md index 10ae06b75e..cbb62bdd8d 100644 --- a/docs/content/contribute/_index.md +++ b/docs/content/contribute/_index.md @@ -11,11 +11,13 @@ menu: name: Get involved url: /contribute/ weight: 10 +toc: + enabled: true --- 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 +## Contributing We use GitHub as a collaboration platform for the development of the OSCAL models. Within the OSCAL GitHub repository you will find: diff --git a/docs/content/contribute/dev-lunch/_index.md b/docs/content/contribute/dev-lunch/_index.md index 1129b96acd..afbb80374c 100644 --- a/docs/content/contribute/dev-lunch/_index.md +++ b/docs/content/contribute/dev-lunch/_index.md @@ -4,9 +4,9 @@ description: The NIST OSCAL team hosts a bi-weekly web conference to discuss OSC layout: devlunch aliases: - /contribute/devlunch/ -sidenav: - toc: - headingselectors: "h3,h4" +toc: + enabled: true + headingselectors: "h3,h4" weight: 10 --- diff --git a/docs/content/contribute/model-review/_index.md b/docs/content/contribute/model-review/_index.md index 8b48bf2cf4..eb1fe20fad 100644 --- a/docs/content/contribute/model-review/_index.md +++ b/docs/content/contribute/model-review/_index.md @@ -2,10 +2,9 @@ title: OSCAL Model Review description: The NIST OSCAL team hosts a bi-weekly web conference to discuss OSCAL model issues. layout: devlunch -sidenav: - toc: - headingselectors: "h3,h4" - includeHtml: true +toc: + headingselectors: "h3,h4" + includeHtml: true weight: 20 --- diff --git a/docs/content/contribute/roadmap.md b/docs/content/contribute/roadmap.md index 2b8d7ceda7..81556972fe 100644 --- a/docs/content/contribute/roadmap.md +++ b/docs/content/contribute/roadmap.md @@ -2,6 +2,8 @@ title: OSCAL Development Roadmap description: Information on the OSCAL development roadmap, which is taking place over a series of milestones. weight: 5 +toc: + enabled: true aliases: - /learnmore/roadmap/ --- diff --git a/docs/content/documentation/concepts/_index.md b/docs/content/documentation/concepts/_index.md index 549d5cc0af..809eb31614 100644 --- a/docs/content/documentation/concepts/_index.md +++ b/docs/content/documentation/concepts/_index.md @@ -5,9 +5,10 @@ description: Reviews the control- and assessment-related concepts used within OS weight: 10 sidenav: title: Concepts Used in OSCAL - toc: - headingselectors: h2,h3,h4,h5 - collapsedepth: 4 +toc: + enabled: true + headingselectors: h2,h3,h4,h5 + collapsedepth: 4 aliases: - /learnmore/concepts/ - /learnmore/concepts/control/ diff --git a/docs/content/documentation/relations-to-other.md b/docs/content/documentation/relations-to-other.md index 91827d55c1..868feb8fc7 100644 --- a/docs/content/documentation/relations-to-other.md +++ b/docs/content/documentation/relations-to-other.md @@ -2,6 +2,8 @@ title: Relations to Other Documentary Encoding Standards description: Explanation of how OSCAL relates to various documentary standards. weight: 100 +toc: + enabled: true aliases: - /docs/relations/ --- diff --git a/docs/content/documentation/schema/_index.md b/docs/content/documentation/schema/_index.md index 0910ced669..41a3e66543 100644 --- a/docs/content/documentation/schema/_index.md +++ b/docs/content/documentation/schema/_index.md @@ -2,12 +2,14 @@ title: Layers and Models Reference description: Provides 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. weight: 50 -aliases: - - /docs/model/ssp/ - - /learnmore/architecture/ +toc: + enabled: true sidenav: activerenderdepth: 1 inactiverenderdepth: 1 +aliases: + - /docs/model/ssp/ + - /learnmore/architecture/ --- The OSCAL architecture is organized in a stack of *layers*. Each lower layer in the stack provides information structures that are referenced and used by each higher layer. Each layer is composed of one or more *models*, which represent a information structure supporting a specific operational purpose. Each model in OSCAL is intended to build on the information provided by the model(s) in the lower layers. diff --git a/docs/content/documentation/schema/assessment-layer/assessment-plan/_index.md b/docs/content/documentation/schema/assessment-layer/assessment-plan/_index.md index 9ee2fa8f33..f57b043c00 100644 --- a/docs/content/documentation/schema/assessment-layer/assessment-plan/_index.md +++ b/docs/content/documentation/schema/assessment-layer/assessment-plan/_index.md @@ -3,6 +3,8 @@ title: Assessment Plan Model heading: "OSCAL Assessment Layer: Assessment Plan Model" description: XML and JSON format documentation for the OSCAL Assessment Plan model, which is part of the OSCAL Assessment layer. These formats model the planning of a periodic or continuous assessment. weight: 60 +toc: + enabled: true aliases: - /documentation/schema/assessment-plan/ --- diff --git a/docs/content/documentation/schema/assessment-layer/assessment-plan/json-schema.md b/docs/content/documentation/schema/assessment-layer/assessment-plan/json-schema.md index 01f9f57a9f..ee3da8c7f6 100644 --- a/docs/content/documentation/schema/assessment-layer/assessment-plan/json-schema.md +++ b/docs/content/documentation/schema/assessment-layer/assessment-plan/json-schema.md @@ -5,8 +5,9 @@ description: Object-level definitions of the OSCAL Assessment Plan model JSON fo weight: 20 sidenav: title: JSON Format Reference - toc: - headingselectors: "h2.toc1, h3.toc2" +toc: + enabled: true + headingselectors: "h2.toc1, h3.toc2" aliases: - /documentation/schema/assessment-plan/json-schema/ --- diff --git a/docs/content/documentation/schema/assessment-layer/assessment-plan/xml-schema.md b/docs/content/documentation/schema/assessment-layer/assessment-plan/xml-schema.md index 0badc48868..ed775187b6 100644 --- a/docs/content/documentation/schema/assessment-layer/assessment-plan/xml-schema.md +++ b/docs/content/documentation/schema/assessment-layer/assessment-plan/xml-schema.md @@ -5,8 +5,9 @@ description: Element-level definitions of the OSCAL Assessment Plan model XML fo weight: 60 sidenav: title: XML Format Reference - toc: - headingselectors: "h2.toc1, h3.toc2" +toc: + enabled: true + headingselectors: "h2.toc1, h3.toc2" aliases: - /documentation/schema/assessment-plan/xml-schema/ --- diff --git a/docs/content/documentation/schema/assessment-results-layer/assessment-results/_index.md b/docs/content/documentation/schema/assessment-results-layer/assessment-results/_index.md index c0ffee99f4..6f46ae7cc1 100644 --- a/docs/content/documentation/schema/assessment-results-layer/assessment-results/_index.md +++ b/docs/content/documentation/schema/assessment-results-layer/assessment-results/_index.md @@ -3,6 +3,8 @@ title: Assessment Results Model heading: "OSCAL Assessment Layer: Assessment Results Model" description: XML and JSON format documentation for the OSCAL Assessment Results model, which is part of the OSCAL Assessment Results layer. These formats model the findings of a periodic or continuous assessment. weight: 65 +toc: + enabled: true aliases: - /documentation/schema/assessment-results/ --- diff --git a/docs/content/documentation/schema/assessment-results-layer/assessment-results/json-schema.md b/docs/content/documentation/schema/assessment-results-layer/assessment-results/json-schema.md index ac9ac54b01..0788f2a1ab 100644 --- a/docs/content/documentation/schema/assessment-results-layer/assessment-results/json-schema.md +++ b/docs/content/documentation/schema/assessment-results-layer/assessment-results/json-schema.md @@ -5,8 +5,9 @@ description: Object-level definitions of the OSCAL Assessment Results model JSON weight: 20 sidenav: title: JSON Format Reference - toc: - headingselectors: "h2.toc1, h3.toc2" +toc: + enabled: true + headingselectors: "h2.toc1, h3.toc2" aliases: - /documentation/schema/assessment-results/json-schema/ --- diff --git a/docs/content/documentation/schema/assessment-results-layer/assessment-results/xml-schema.md b/docs/content/documentation/schema/assessment-results-layer/assessment-results/xml-schema.md index ba725c72db..55d05ead86 100644 --- a/docs/content/documentation/schema/assessment-results-layer/assessment-results/xml-schema.md +++ b/docs/content/documentation/schema/assessment-results-layer/assessment-results/xml-schema.md @@ -5,8 +5,9 @@ description: Element-level definitions of the OSCAL Assessment Results model XML weight: 60 sidenav: title: XML Format Reference - toc: - headingselectors: "h2.toc1, h3.toc2" +toc: + enabled: true + headingselectors: "h2.toc1, h3.toc2" aliases: - /documentation/schema/assessment-results/xml-schema/ --- diff --git a/docs/content/documentation/schema/assessment-results-layer/poam/_index.md b/docs/content/documentation/schema/assessment-results-layer/poam/_index.md index ee71b4cb6c..ec8c851463 100644 --- a/docs/content/documentation/schema/assessment-results-layer/poam/_index.md +++ b/docs/content/documentation/schema/assessment-results-layer/poam/_index.md @@ -3,6 +3,8 @@ title: Plan of Action and Milestones (POA&M) Model heading: "OSCAL Assessment Results Layer: Plan of Action and Milestones (POA&M) Model" description: XML and JSON format documentation for the OSCAL Plan of Action and Milestones (POA&M) model, which is part of the OSCAL Assessment Results layer. These formats model the findings of a periodic or continuous assessment. weight: 70 +toc: + enabled: true aliases: - /documentation/schema/poam/ --- diff --git a/docs/content/documentation/schema/assessment-results-layer/poam/json-schema.md b/docs/content/documentation/schema/assessment-results-layer/poam/json-schema.md index 6e662fc548..80b4c5798f 100644 --- a/docs/content/documentation/schema/assessment-results-layer/poam/json-schema.md +++ b/docs/content/documentation/schema/assessment-results-layer/poam/json-schema.md @@ -5,8 +5,9 @@ description: Object-level definitions of the OSCAL Plan of Action and Milestones weight: 20 sidenav: title: JSON Format Reference - toc: - headingselectors: "h2.toc1, h3.toc2" +toc: + enabled: true + headingselectors: "h2.toc1, h3.toc2" aliases: - /documentation/schema/poam/json-schema/ --- diff --git a/docs/content/documentation/schema/assessment-results-layer/poam/xml-schema.md b/docs/content/documentation/schema/assessment-results-layer/poam/xml-schema.md index 985ccb4735..291d87b49a 100644 --- a/docs/content/documentation/schema/assessment-results-layer/poam/xml-schema.md +++ b/docs/content/documentation/schema/assessment-results-layer/poam/xml-schema.md @@ -5,8 +5,9 @@ description: Element-level definitions of the OSCAL Plan of Action and Milestone weight: 60 sidenav: title: XML Format Reference - toc: - headingselectors: "h2.toc1, h3.toc2" +toc: + enabled: true + headingselectors: "h2.toc1, h3.toc2" aliases: - /documentation/schema/poam/xml-schema/ --- diff --git a/docs/content/documentation/schema/catalog-layer/_index.md b/docs/content/documentation/schema/catalog-layer/_index.md index d5571d5e5d..68126d40da 100644 --- a/docs/content/documentation/schema/catalog-layer/_index.md +++ b/docs/content/documentation/schema/catalog-layer/_index.md @@ -6,6 +6,8 @@ weight: 70 sidenav: activerenderdepth: 2 inactiverenderdepth: 2 +toc: + enabled: true --- The OSCAL catalog layer provides a structured catalog model for representing a **catalog** of **controls**. diff --git a/docs/content/documentation/schema/catalog-layer/catalog/_index.md b/docs/content/documentation/schema/catalog-layer/catalog/_index.md index 9fa8f914a4..69f498d969 100644 --- a/docs/content/documentation/schema/catalog-layer/catalog/_index.md +++ b/docs/content/documentation/schema/catalog-layer/catalog/_index.md @@ -3,6 +3,8 @@ title: Catalog Model heading: "OSCAL Catalog Layer: Catalog Model" description: XML and JSON format documentation for the OSCAL Catalog model, which models a [control catalog](/documentation/schema/catalog-layer/#catalog). weight: 30 +toc: + enabled: true aliases: - /docs/model/catalog/ - /documentation/schema/catalog/ diff --git a/docs/content/documentation/schema/catalog-layer/catalog/json-schema.md b/docs/content/documentation/schema/catalog-layer/catalog/json-schema.md index 6a811e88bb..d82afa696c 100644 --- a/docs/content/documentation/schema/catalog-layer/catalog/json-schema.md +++ b/docs/content/documentation/schema/catalog-layer/catalog/json-schema.md @@ -7,8 +7,9 @@ aliases: weight: 20 sidenav: title: JSON Format Reference - toc: - headingselectors: "h2.toc1, h3.toc2" +toc: + enabled: true + headingselectors: "h2.toc1, h3.toc2" aliases: - /documentation/schema/catalog/json-schema/ --- diff --git a/docs/content/documentation/schema/catalog-layer/catalog/xml-schema.md b/docs/content/documentation/schema/catalog-layer/catalog/xml-schema.md index 6c4c212c87..e242a06a41 100644 --- a/docs/content/documentation/schema/catalog-layer/catalog/xml-schema.md +++ b/docs/content/documentation/schema/catalog-layer/catalog/xml-schema.md @@ -7,8 +7,9 @@ aliases: weight: 60 sidenav: title: XML Format Reference - toc: - headingselectors: "h2.toc1, h3.toc2" +toc: + enabled: true + headingselectors: "h2.toc1, h3.toc2" aliases: - /documentation/schema/catalog/xml-schema/ --- diff --git a/docs/content/documentation/schema/datatypes.md b/docs/content/documentation/schema/datatypes.md index bdb6e946d5..82563ab92d 100644 --- a/docs/content/documentation/schema/datatypes.md +++ b/docs/content/documentation/schema/datatypes.md @@ -3,6 +3,8 @@ title: OSCAL Data Types heading: Data Types Used in OSCAL description: A description of the data types used in the OSCAL formats. weight: 20 +toc: + enabled: true aliases: - /docs/schemas/datatypes/ - /documentation/schema/datatypes/ diff --git a/docs/content/documentation/schema/implementation-layer/component/_index.md b/docs/content/documentation/schema/implementation-layer/component/_index.md index 3ce94e1f20..e008c665d2 100644 --- a/docs/content/documentation/schema/implementation-layer/component/_index.md +++ b/docs/content/documentation/schema/implementation-layer/component/_index.md @@ -3,6 +3,8 @@ title: Component Definition Model heading: "OSCAL Implementation Layer: Component Definition Model" description: XML and JSON format documentation for the OSCAL Component Definition model, which is part of the OSCAL implementation layer in the OSCAL [Layers and Models Reference](/documentation/schema/). These formats model a description of the controls that are supported in a given implementation of a hardware, software, service, policy, process, procedure, or compliance artifact (e.g., FIPS 140-2 validation). weight: 50 +toc: + enabled: true aliases: - /docs/model/component/ - /documentation/schema/component/ diff --git a/docs/content/documentation/schema/implementation-layer/component/json-schema.md b/docs/content/documentation/schema/implementation-layer/component/json-schema.md index 1e351e4f54..3a0cc475db 100644 --- a/docs/content/documentation/schema/implementation-layer/component/json-schema.md +++ b/docs/content/documentation/schema/implementation-layer/component/json-schema.md @@ -7,8 +7,9 @@ aliases: weight: 20 sidenav: title: JSON Format Reference - toc: - headingselectors: "h2.toc1, h3.toc2" +toc: + enabled: true + headingselectors: "h2.toc1, h3.toc2" aliases: - /documentation/schema/component/json-schema/ --- diff --git a/docs/content/documentation/schema/implementation-layer/component/xml-schema.md b/docs/content/documentation/schema/implementation-layer/component/xml-schema.md index 57b459019a..bb10739808 100644 --- a/docs/content/documentation/schema/implementation-layer/component/xml-schema.md +++ b/docs/content/documentation/schema/implementation-layer/component/xml-schema.md @@ -7,8 +7,9 @@ aliases: weight: 60 sidenav: title: XML Format Reference - toc: - headingselectors: "h2.toc1, h3.toc2" +toc: + enabled: true + headingselectors: "h2.toc1, h3.toc2" aliases: - /documentation/schema/component/xml-schema/ --- diff --git a/docs/content/documentation/schema/implementation-layer/ssp/_index.md b/docs/content/documentation/schema/implementation-layer/ssp/_index.md index fdb4922d62..7b5b7bb693 100644 --- a/docs/content/documentation/schema/implementation-layer/ssp/_index.md +++ b/docs/content/documentation/schema/implementation-layer/ssp/_index.md @@ -3,6 +3,8 @@ title: System Security Plan Model (SSP) heading: "OSCAL Implementation Layer: System Security Plan (SSP) Model" description: XML and JSON format documentation for the OSCAL System Security Plan (SSP) model, which is part of the OSCAL implementation layer in the OSCAL [Layers and Models Reference](/documentation/schema/). These formats model the control implementation of an information system. weight: 55 +toc: + enabled: true aliases: - /documentation/schema/ssp/ --- diff --git a/docs/content/documentation/schema/implementation-layer/ssp/json-schema.md b/docs/content/documentation/schema/implementation-layer/ssp/json-schema.md index ec0324946f..416df782f3 100644 --- a/docs/content/documentation/schema/implementation-layer/ssp/json-schema.md +++ b/docs/content/documentation/schema/implementation-layer/ssp/json-schema.md @@ -7,8 +7,9 @@ aliases: weight: 20 sidenav: title: JSON Format Reference - toc: - headingselectors: "h2.toc1, h3.toc2" +toc: + enabled: true + headingselectors: "h2.toc1, h3.toc2" aliases: - /documentation/schema/ssp/json-schema/ --- diff --git a/docs/content/documentation/schema/implementation-layer/ssp/xml-schema.md b/docs/content/documentation/schema/implementation-layer/ssp/xml-schema.md index e87dd4b57c..ae41343491 100644 --- a/docs/content/documentation/schema/implementation-layer/ssp/xml-schema.md +++ b/docs/content/documentation/schema/implementation-layer/ssp/xml-schema.md @@ -7,8 +7,9 @@ aliases: weight: 60 sidenav: title: XML Format Reference - toc: - headingselectors: "h2.toc1, h3.toc2" +toc: + enabled: true + headingselectors: "h2.toc1, h3.toc2" aliases: - /documentation/schema/ssp/xml-schema/ --- diff --git a/docs/content/documentation/schema/implementation-layer/validation-modeling.md b/docs/content/documentation/schema/implementation-layer/validation-modeling.md index 0adad46e96..443e6b269d 100644 --- a/docs/content/documentation/schema/implementation-layer/validation-modeling.md +++ b/docs/content/documentation/schema/implementation-layer/validation-modeling.md @@ -3,6 +3,8 @@ title: Representing Test Validation Information heading: "Representing Test Validation Information for Components" description: Discussed how test validation information (e.g., ) can be represented for an OSCAL [component](/documentation/schema/implementation-layer/component/). weight: 50 +toc: + enabled: true sidenav: activerenderdepth: 2 inactiverenderdepth: 2 diff --git a/docs/content/documentation/schema/overview.md b/docs/content/documentation/schema/overview.md index 418f78d2eb..5ecbb45e77 100644 --- a/docs/content/documentation/schema/overview.md +++ b/docs/content/documentation/schema/overview.md @@ -3,6 +3,8 @@ title: OSCAL Model Overview heading: Introduction to the OSCAL Models description: Reviews OSCAL modeling concepts, and discusses the supported OSCAL formats and related validation mechanisms. weight: 10 +toc: + enabled: true sidenav: title: OSCAL Model Overview aliases: diff --git a/docs/content/documentation/schema/profile-layer/_index.md b/docs/content/documentation/schema/profile-layer/_index.md index e4fff2c2f6..c9d47ab577 100644 --- a/docs/content/documentation/schema/profile-layer/_index.md +++ b/docs/content/documentation/schema/profile-layer/_index.md @@ -3,6 +3,8 @@ title: Profile Layer heading: "OSCAL Profile Layer" description: Provides the OSCAL [profile model](/documentation/schema/profile-layer/profile/), which represents a [profile](/learnmore/concepts/profile/), also known as a *baseline* or *overlay*. weight: 60 +toc: + enabled: true sidenav: activerenderdepth: 2 inactiverenderdepth: 2 diff --git a/docs/content/documentation/schema/profile-layer/profile/_index.md b/docs/content/documentation/schema/profile-layer/profile/_index.md index 57f21f2ad7..a2206f3c4c 100644 --- a/docs/content/documentation/schema/profile-layer/profile/_index.md +++ b/docs/content/documentation/schema/profile-layer/profile/_index.md @@ -3,6 +3,8 @@ title: Profile Model heading: "OSCAL Profile Layer: Profile Model" description: XML and JSON format documentation for the OSCAL [Profile model](.), which is the sole model in the OSCAL [Profile](../) layer. These formats model a [profile](/documentation/schema/profile-layer/#profile). weight: 40 +toc: + enabled: true aliases: - /docs/model/profile/ - /documentation/schema/profile/ diff --git a/docs/content/documentation/schema/profile-layer/profile/json-schema.md b/docs/content/documentation/schema/profile-layer/profile/json-schema.md index 03a51ceafe..ed3546004f 100644 --- a/docs/content/documentation/schema/profile-layer/profile/json-schema.md +++ b/docs/content/documentation/schema/profile-layer/profile/json-schema.md @@ -7,8 +7,9 @@ aliases: weight: 20 sidenav: title: JSON Format Reference - toc: - headingselectors: "h2.toc1, h3.toc2" +toc: + enabled: true + headingselectors: "h2.toc1, h3.toc2" aliases: - /documentation/schema/profile/json-schema/ --- diff --git a/docs/content/documentation/schema/profile-layer/profile/xml-schema.md b/docs/content/documentation/schema/profile-layer/profile/xml-schema.md index e50616b071..126e5a3c88 100644 --- a/docs/content/documentation/schema/profile-layer/profile/xml-schema.md +++ b/docs/content/documentation/schema/profile-layer/profile/xml-schema.md @@ -7,8 +7,9 @@ aliases: weight: 60 sidenav: title: XML Format Reference - toc: - headingselectors: "h2.toc1, h3.toc2" +toc: + enabled: true + headingselectors: "h2.toc1, h3.toc2" aliases: - /documentation/schema/profile/xml-schema/ --- diff --git a/docs/content/downloads/_index.md b/docs/content/downloads/_index.md index cdf24c8df4..ae61ad5c8a 100644 --- a/docs/content/downloads/_index.md +++ b/docs/content/downloads/_index.md @@ -4,6 +4,8 @@ menu: primary: name: Downloads weight: 50 +toc: + enabled: true --- Official releases of the OSCAL Project are available on the project's [GitHub repository](https://github.com/usnistgov/OSCAL/releases). These releases align with the project's [roadmap](/contribute/roadmap/). @@ -17,7 +19,7 @@ You can also get the [latest development version](https://github.com/usnistgov/O OSCAL uses version strings for releases based on the [semantic versioning v2.0.0](https://semver.org/spec/v2.0.0.html) specification. -# Future OSCAL Compatibility Commitment +## Future OSCAL Compatibility Commitment The OSCAL Project team recognizes the impact of syntax changes on content and tool developers following an evolving language. As we develop OSCAL, the team will take care to minimize the impact of any necessary changes. Syntax changes to the OSCAL XML and JSON models will only occur where there is a compelling need to do so. To the greatest extend practical, OSCAL-based content produced today will be future compatible. diff --git a/docs/content/downloads/other-resources.md b/docs/content/downloads/other-resources.md index 1b8f04ab90..2f5c88bc42 100644 --- a/docs/content/downloads/other-resources.md +++ b/docs/content/downloads/other-resources.md @@ -1,6 +1,8 @@ --- title: Related Resources description: Other resources related to the OSCAL project, including links to tools, presentations, and news items. +toc: + enabled: true aliases: - /resources/ --- diff --git a/docs/content/learnmore/_index.md b/docs/content/learnmore/_index.md index 3402635c4e..189aee1090 100644 --- a/docs/content/learnmore/_index.md +++ b/docs/content/learnmore/_index.md @@ -5,6 +5,8 @@ menu: primary: name: Learn More weight: 10 +toc: + enabled: true --- NIST is developing the Open Security Controls Assessment Language (OSCAL) as a standardized, data-centric framework that can be applied to an information system for documenting and assessing its security controls. Today, security controls and control baselines are represented in proprietary formats, requiring data conversion and manual effort to describe their implementation. An important goal of OSCAL is to move the security controls and control baselines from a text-based and manual approach (using word processors or spreadsheets) to a set of standardized and machine-readable formats. With systems security information represented in OSCAL, security professionals will be able to automate security assessment, auditing, and continuous monitoring processes. diff --git a/docs/content/learnmore/challenges.md b/docs/content/learnmore/challenges.md index 0a19d76c63..69bc1e09b1 100644 --- a/docs/content/learnmore/challenges.md +++ b/docs/content/learnmore/challenges.md @@ -2,6 +2,8 @@ title: Challenges Addressed by OSCAL description: OSCAL addresses a number of challenges related to the definition and assessment of security controls. weight: 10 +toc: + enabled: true --- OSCAL addresses a number of challenges around security controls and security control assessment. diff --git a/docs/content/learnmore/goals.md b/docs/content/learnmore/goals.md index 66f05d3a58..3c77c52ae4 100644 --- a/docs/content/learnmore/goals.md +++ b/docs/content/learnmore/goals.md @@ -3,6 +3,8 @@ title: Project Goals and Design Principles description: OSCAL is being developed to address a number of challenges faced by information security professionals. heading: weight: 30 +toc: + enabled: true --- ## Goals of the OSCAL Project diff --git a/docs/content/learnmore/stakeholders/_index.md b/docs/content/learnmore/stakeholders/_index.md index 21d0562c2b..7f99e96523 100644 --- a/docs/content/learnmore/stakeholders/_index.md +++ b/docs/content/learnmore/stakeholders/_index.md @@ -2,7 +2,8 @@ title: OSCAL Stakeholders description: OSCAL supports the needs of many different stakeholder groups. weight: 50 - +toc: + enabled: true --- Our stakeholders are segmented, as is our industry, into constituencies with various needs. diff --git a/docs/content/learnmore/stakeholders/assessors.md b/docs/content/learnmore/stakeholders/assessors.md index 47b89651c0..5a737fec31 100644 --- a/docs/content/learnmore/stakeholders/assessors.md +++ b/docs/content/learnmore/stakeholders/assessors.md @@ -2,9 +2,10 @@ title: For Assessors heading: How can assessors get involved? description: How can assessors get involved? +toc: + enabled: true aliases: - /learnmore/assessors/ - --- {{}}*Audit and assessment personnel who validate the accuracy of security plans and assess the implementation of security controls within information systems.*{{}} diff --git a/docs/content/learnmore/stakeholders/contentcreators.md b/docs/content/learnmore/stakeholders/contentcreators.md index a22f446ca7..685e04c65f 100644 --- a/docs/content/learnmore/stakeholders/contentcreators.md +++ b/docs/content/learnmore/stakeholders/contentcreators.md @@ -2,6 +2,8 @@ title: For Baseline Authors heading: How can authors of baselines get involved? description: How can authors of baselines get involved? +toc: + enabled: true aliases: - /learnmore/contentcreators/ --- diff --git a/docs/content/learnmore/stakeholders/securitypros.md b/docs/content/learnmore/stakeholders/securitypros.md index 4c8876a57f..6e78f08944 100644 --- a/docs/content/learnmore/stakeholders/securitypros.md +++ b/docs/content/learnmore/stakeholders/securitypros.md @@ -2,6 +2,8 @@ title: For Security Professionals heading: How can security professionals get involved? description: How can security professionals get involved? +toc: + enabled: true aliases: - /learnmore/securitypros/ --- diff --git a/docs/content/learnmore/stakeholders/tooldevelopers.md b/docs/content/learnmore/stakeholders/tooldevelopers.md index b665da2b97..d8d1f7706e 100644 --- a/docs/content/learnmore/stakeholders/tooldevelopers.md +++ b/docs/content/learnmore/stakeholders/tooldevelopers.md @@ -3,6 +3,8 @@ title: title: For Tool Developers heading: How can tool developers get involved? description: How can tool developers get involved? +toc: + enabled: true aliases: - /learnmore/tooldevelopers/ --- diff --git a/docs/content/learnmore/use-cases/_index.md b/docs/content/learnmore/use-cases/_index.md index 6a36a15c1a..cff2e41103 100644 --- a/docs/content/learnmore/use-cases/_index.md +++ b/docs/content/learnmore/use-cases/_index.md @@ -2,6 +2,8 @@ title: Use Cases description: OSCAL supports a number of use cases. weight: 70 +toc: + enabled: true aliases: - /learnmore/scenarios/ - /learnmore/casestudies/ diff --git a/docs/content/tools/_index.md b/docs/content/tools/_index.md index ca34bf5c7f..facea833d0 100644 --- a/docs/content/tools/_index.md +++ b/docs/content/tools/_index.md @@ -5,6 +5,8 @@ menu: primary: name: Tools weight: 30 +toc: + enabled: true --- The [OSCAL models](/documentation/schema/) provide standardized formats for exchanging control, control implementation, and control assessment information in XML, JSON, and YAML. These formats allow this information to be exchanged between tools and for individual tools to process exchanged data, supporting analytics, user interaction, and increased automation. diff --git a/docs/content/tutorials/catalog/_index.md b/docs/content/tutorials/catalog/_index.md index 2516afd88b..01bf60fe7f 100644 --- a/docs/content/tutorials/catalog/_index.md +++ b/docs/content/tutorials/catalog/_index.md @@ -3,6 +3,8 @@ title: Creating a Basic Control Catalog description: A tutorial on creating a basic OSCAL control catalog. weight: 5 suppresstopiclist: true +toc: + enabled: true --- This tutorial covers creating a basic OSCAL control catalog. Before reading this tutorial you should: diff --git a/docs/layouts/_default/devlunch.html b/docs/layouts/_default/devlunch.html index ad43e1f050..e08f9da638 100644 --- a/docs/layouts/_default/devlunch.html +++ b/docs/layouts/_default/devlunch.html @@ -6,6 +6,9 @@
{{ $firstSection := .Page.FirstSection.Pages }} +{{- $gridMainWidescreenSize := 12 -}} +{{- $gridMainDesktopSize := 12 -}} + {{/* includeTopLevel is used to determine if the top-level section should appear in the side navigation */}} {{ $includeTopLevel := true }} @@ -15,11 +18,23 @@ {{ end }} {{ end }} {{ if and .Page.FirstSection (or ($includeTopLevel) (gt (len .Page.FirstSection.Pages) 0)) }} - + + {{- $gridMainWidescreenSize = sub $gridMainWidescreenSize 3 -}} + {{- $gridMainDesktopSize = sub $gridMainDesktopSize 2 -}} +{{ end -}} +{{- $tocEnabled := false -}} +{{- with .Page.Params.toc -}} + {{- if isset . "enabled" -}} + {{- $tocEnabled = .enabled -}} + {{- end -}} +{{- end -}} +{{ if $tocEnabled }} + {{- $gridMainWidescreenSize = sub $gridMainWidescreenSize 2 -}} + {{- $gridMainDesktopSize = sub $gridMainDesktopSize 2 -}} {{ end -}} -
+
{{ if isset .Params "heading" }}

{{ .Params.heading }}

{{else}}

{{ .Title }}

{{ end }} @@ -29,7 +44,7 @@ {{ if gt (len .Pages) 0 }}

Meeting Archive

{{ range .Pages.GroupByDate "2006" }} -

{{ .Key }}

+

{{ .Key }}

{{ range .Pages.ByDate.Reverse }}
@@ -45,6 +60,11 @@

{{ .Date.Format "Jan 2, 2 {{ end }} {{ end }}

+ {{ if $tocEnabled }} + + {{ end -}}
diff --git a/docs/themes/uswds b/docs/themes/uswds index 17fd72b663..2eb05326e7 160000 --- a/docs/themes/uswds +++ b/docs/themes/uswds @@ -1 +1 @@ -Subproject commit 17fd72b6631e8f033f6b49ebd2291e938e7bed11 +Subproject commit 2eb05326e78285d1092769acc57ffd5101aac269 diff --git a/docs/themes/uswds.rej b/docs/themes/uswds.rej deleted file mode 100644 index 6a729d3941..0000000000 --- a/docs/themes/uswds.rej +++ /dev/null @@ -1,5 +0,0 @@ ---- docs/themes/uswds -+++ docs/themes/uswds -@@ -1 +1 @@ --Subproject commit 764e52ad21f9e5aeefd142f90886d1e6c237d3f2 -+Subproject commit 8f3c04ce04db2279697682719478945e7a69952e