Consolidation of some site information into resources section (#38)

* Initial page relocation for #24. * Remove header directives. * Updates existing and add new 2nd level aliases As part of the site re-org, we must add aliases to the make old links work for users finding old references or using old bookmarks. For top level targets that have moved into resources we add an alias to the old location on the site. In the case of concepts, we have many nested pages in sub-directories. These 2nd level links are also now accounted for. * Add copy for how to use different resources. * Update nav order with @Arminta-Jenkins-NIST's recommendations Before the website reorganization on develop, the top-level navigation had the following order. - About - Learn - Concepts - Reference - Downloads - Examples - Tools - Contribute - Events - Contact us With previous commits and this final commit we have reorganized it like so. - News - About - Learn - Resources - Concepts - Reference - Downloads - Examples - Tools - Contribute - Events - Contact us * Address alias indent error from @Arminta-Jenkins-NIST's feedback.
usnistgov · Sep 12, 2023 · 9a10f5b · 9a10f5b
1 parent ff3a0a9
commit 9a10f5b
Show file tree

Hide file tree

Showing 46 changed files with 65 additions and 23 deletions.
diff --git a/src/config.yaml b/src/config.yaml
@@ -38,10 +38,6 @@ params:
   sidenav:
 #    debug: true
 menu:
-  primary:
-  - name: Reference
-    url: https://pages.nist.gov/OSCAL-Reference/
-    weight: 30
   secondary:
   - name: Github
     url: https://github.com/usnistgov/OSCAL

diff --git a/src/content/learn/_index.md b/src/content/learn/_index.md
@@ -3,7 +3,7 @@ title: Learning Resources
 menu:
   primary:
     name: Learn
-    weight: 25
+    weight: 20
 suppresstopiclists: true
 ---
 

diff --git a/src/content/resources/_index.md b/src/content/resources/_index.md
@@ -0,0 +1,38 @@
+---
+title: OSCAL Resources
+heading: OSCAL Resources
+menu:
+  primary:
+    name: Resources
+    weight: 25
+sidenav:
+  focusrenderdepth: 2
+  inactiverenderdepth: 2
+  activerenderdepth: 2
+---
+
+The OSCAL project maintains a variety of resources to learn and use OSCAL.
+
+## Learn
+
+### Concepts
+
+The [concepts](./concepts/) section contains detailed information about the organization of OSCAL models, processing specifications, and explanations of important primitives (i.e. identifiers) underlying OSCAL data elements.
+
+### Reference
+
+The [reference](https://pages.nist.gov/OSCAL-Reference) section contains the full details of all OSCAL models for development snapshots and all published releases, with visualizations of models in outline form, reference documentation for individual elements, and indices for the location of all elements across all models.
+
+## Use
+
+### Downloads
+
+The [downloads](./downloads/) page has links and instructions to download releases and development snapshots of the OSCAL data models.
+
+### Examples
+
+The [examples](./examples/) page has links and information to examples of OSCAL content in the official NIST repositories.
+
+### Tools
+
+The [tools](./tools) page has information about NIST's reference implementations of software and reusable libraries. Additionally, there are links to community-maintained lists of software and information about OSCAL-enabled tools.
diff --git a/src/content/concepts/_index.md → src/content/resources/concepts/_index.md b/src/content/concepts/_index.md → src/content/resources/concepts/_index.md
@@ -1,9 +1,5 @@
 ---
 title: "OSCAL Concepts"
-menu:
-  primary:
-    name: Concepts
-    weight: 30
 suppresstopiclist: true
 sidenav:
   focusrenderdepth: 2
@@ -12,6 +8,7 @@ sidenav:
 aliases:
   - /docs/schemas/
   - /documentation/
+  - /concepts/
 ---
 
 This section of the OSCAL website presents:

diff --git a/src/content/concepts/examples.md → src/content/resources/concepts/examples.md b/src/content/concepts/examples.md → src/content/resources/concepts/examples.md
@@ -3,8 +3,8 @@ title: OSCAL Content Examples
 description: Provides information on where to find OSCAL content examples.
 weight: 90
 aliases:
-  - /resources/examples/
   - /documentation/examples/
+  - /concepts/examples/
 ---
 
 The [OSCAL content repository]({{< param "contentRepoPath" >}}) on GitHub provides many examples of OSCAL formatted data including both actual data and mockups for demonstration.
diff --git a/...content/concepts/identifier-use/_index.md → ...sources/concepts/identifier-use/_index.md b/...content/concepts/identifier-use/_index.md → ...sources/concepts/identifier-use/_index.md
@@ -9,6 +9,8 @@ sidenav:
   focusrenderdepth: 2
   activerenderdepth: 2
   inactiverenderdepth: 2
+aliases:
+  - /concepts/identifier-use/
 ---
 
 This page reviews important concepts to be aware of when declaring or referencing identifiers in OSCAL models, with in-depth explanations of identifier uniqueness and scope.  

diff --git a/...ntifier-use/oscal-model-relationships.svg → ...ntifier-use/oscal-model-relationships.svg b/...ntifier-use/oscal-model-relationships.svg → ...ntifier-use/oscal-model-relationships.svg
diff --git a/src/content/concepts/layer/OSCAL-file.svg → ...t/resources/concepts/layer/OSCAL-file.svg b/src/content/concepts/layer/OSCAL-file.svg → ...t/resources/concepts/layer/OSCAL-file.svg
diff --git a/src/content/concepts/layer/_index.md → ...ontent/resources/concepts/layer/_index.md b/src/content/concepts/layer/_index.md → ...ontent/resources/concepts/layer/_index.md
@@ -13,6 +13,7 @@ aliases:
   - /docs/model/ssp/
   - /learnmore/architecture/
   - /documentation/schema/
+  - /concepts/layer/
 ---
 
 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/...ntent/concepts/layer/assessment/_index.md → ...urces/concepts/layer/assessment/_index.md b/...ntent/concepts/layer/assessment/_index.md → ...urces/concepts/layer/assessment/_index.md
@@ -11,6 +11,7 @@ toc:
 aliases:
   - /documentation/schema/assessment-layer/
   - /documentation/schema/assessment-results-layer/
+  - /concepts/layer/assessment/
 ---
 
 The OSCAL assessment layer provides models for describing how an assessment is planned, performed, and how the results of assessment activities are reported.

diff --git a/...ment-plan/OSCAL-stack-assessment_plan.svg → ...ment-plan/OSCAL-stack-assessment_plan.svg b/...ment-plan/OSCAL-stack-assessment_plan.svg → ...ment-plan/OSCAL-stack-assessment_plan.svg
diff --git a/...ayer/assessment/assessment-plan/_index.md → ...ayer/assessment/assessment-plan/_index.md b/...ayer/assessment/assessment-plan/_index.md → ...ayer/assessment/assessment-plan/_index.md
@@ -8,6 +8,7 @@ toc:
 aliases:
   - /documentation/schema/assessment-plan/
   - /documentation/schema/assessment-layer/assessment-plan/
+  - /concepts/layer/assessment/assessment-plan/
 ---
 
 | Assessment Plan Schema | Assessment Plan Converters | Reference

diff --git a/...assessment-plan/assessment-plan-model.svg → ...assessment-plan/assessment-plan-model.svg b/...assessment-plan/assessment-plan-model.svg → ...assessment-plan/assessment-plan-model.svg
diff --git a/...esults/OSCAL-stack-assessment_results.svg → ...esults/OSCAL-stack-assessment_results.svg b/...esults/OSCAL-stack-assessment_results.svg → ...esults/OSCAL-stack-assessment_results.svg
diff --git a/...r/assessment/assessment-results/_index.md → ...r/assessment/assessment-results/_index.md b/...r/assessment/assessment-results/_index.md → ...r/assessment/assessment-results/_index.md
@@ -8,6 +8,7 @@ toc:
 aliases:
   - /documentation/schema/assessment-results/
   - /documentation/schema/assessment-results-layer/assessment-results/
+  - /concepts/layer/assessment/assessment-results/
 ---
 
 | Assessment Results Schema | Assessment Results Converters | Reference

diff --git a/...ment-results/assessment-results-model.svg → ...ment-results/assessment-results-model.svg b/...ment-results/assessment-results-model.svg → ...ment-results/assessment-results-model.svg
diff --git a/...ayer/assessment/poam/OSCAL-stack-POAM.svg → ...ayer/assessment/poam/OSCAL-stack-POAM.svg b/...ayer/assessment/poam/OSCAL-stack-POAM.svg → ...ayer/assessment/poam/OSCAL-stack-POAM.svg
diff --git a/.../concepts/layer/assessment/poam/_index.md → .../concepts/layer/assessment/poam/_index.md b/.../concepts/layer/assessment/poam/_index.md → .../concepts/layer/assessment/poam/_index.md
@@ -8,6 +8,7 @@ toc:
 aliases:
   - /documentation/schema/poam/
   - /documentation/schema/assessment-results-layer/poam/
+  - /concepts/layer/assessment/poam/
 ---
 
 | POA&M Schema | POA&M Converters | Reference

diff --git a/...epts/layer/assessment/poam/poam-model.svg → ...epts/layer/assessment/poam/poam-model.svg b/...epts/layer/assessment/poam/poam-model.svg → ...epts/layer/assessment/poam/poam-model.svg
diff --git a/src/content/concepts/layer/control/_index.md → ...esources/concepts/layer/control/_index.md b/src/content/concepts/layer/control/_index.md → ...esources/concepts/layer/control/_index.md
@@ -11,6 +11,7 @@ toc:
 aliases:
   - /documentation/schema/catalog-layer/
   - /documentation/schema/profile-layer/
+  - /concepts/layer/control/
 ---
 
 The OSCAL control layer consists of the following models.

diff --git a/.../concepts/layer/control/catalog/_index.md → .../concepts/layer/control/catalog/_index.md b/.../concepts/layer/control/catalog/_index.md → .../concepts/layer/control/catalog/_index.md
@@ -11,6 +11,7 @@ aliases:
   - /documentation/schema/catalog/
   - /documentation/schema/catalog-layer/catalog/
   - /documentation/schema/catalog-layer/catalog/examples/
+  - /concepts/layer/control/catalog/
 suppresstopiclist: true
 ---
 

diff --git a/...s/layer/control/catalog/catalog-model.svg → ...s/layer/control/catalog/catalog-model.svg b/...s/layer/control/catalog/catalog-model.svg → ...s/layer/control/catalog/catalog-model.svg
diff --git a/...r/control/catalog/sp800-53rev5-example.md → ...r/control/catalog/sp800-53rev5-example.md b/...r/control/catalog/sp800-53rev5-example.md → ...r/control/catalog/sp800-53rev5-example.md
diff --git a/...r/control/profile/OSCAL-stack-profile.svg → ...r/control/profile/OSCAL-stack-profile.svg b/...r/control/profile/OSCAL-stack-profile.svg → ...r/control/profile/OSCAL-stack-profile.svg
diff --git a/.../concepts/layer/control/profile/_index.md → .../concepts/layer/control/profile/_index.md b/.../concepts/layer/control/profile/_index.md → .../concepts/layer/control/profile/_index.md
@@ -10,6 +10,7 @@ aliases:
   - /docs/model/profile/
   - /documentation/schema/profile/
   - /documentation/schema/profile-layer/profile/
+  - /concepts/layer/control/profile/
 ---
 
 | Profile Schema | Profile Converters | Reference |

diff --git a/...s/layer/control/profile/profile-model.svg → ...s/layer/control/profile/profile-model.svg b/...s/layer/control/profile/profile-model.svg → ...s/layer/control/profile/profile-model.svg
diff --git a/...t/concepts/layer/implementation/_index.md → ...s/concepts/layer/implementation/_index.md b/...t/concepts/layer/implementation/_index.md → ...s/concepts/layer/implementation/_index.md
diff --git a/...nent-definition/OSCAL-stack-component.svg → ...nent-definition/OSCAL-stack-component.svg b/...nent-definition/OSCAL-stack-component.svg → ...nent-definition/OSCAL-stack-component.svg
diff --git a/...ementation/component-definition/_index.md → ...ementation/component-definition/_index.md b/...ementation/component-definition/_index.md → ...ementation/component-definition/_index.md
@@ -9,6 +9,7 @@ aliases:
   - /docs/model/component/
   - /documentation/schema/component/
   - /documentation/schema/implementation-layer/component/
+  - /concepts/layer/implementation/component/
 ---
 
 | Component Schema | Component Converters | Reference |

diff --git a/.../component-definition/component-model.svg → .../component-definition/component-model.svg b/.../component-definition/component-model.svg → .../component-definition/component-model.svg
diff --git a/...er/implementation/ssp/OSCAL-stack-SSP.svg → ...er/implementation/ssp/OSCAL-stack-SSP.svg b/...er/implementation/ssp/OSCAL-stack-SSP.svg → ...er/implementation/ssp/OSCAL-stack-SSP.svg
diff --git a/...ts/layer/implementation/ssp/SSP-model.svg → ...ts/layer/implementation/ssp/SSP-model.svg b/...ts/layer/implementation/ssp/SSP-model.svg → ...ts/layer/implementation/ssp/SSP-model.svg
diff --git a/...ncepts/layer/implementation/ssp/_index.md → ...ncepts/layer/implementation/ssp/_index.md b/...ncepts/layer/implementation/ssp/_index.md → ...ncepts/layer/implementation/ssp/_index.md
@@ -7,6 +7,7 @@ toc:
 aliases:
   - /documentation/schema/ssp/
   - /documentation/schema/implementation-layer/ssp/
+  - /concepts/layer/implementation/ssp/
 ---
 
 | SSP Schema | SSP Converters | Reference |

diff --git a/src/content/concepts/layer/oscal-layers.svg → ...resources/concepts/layer/oscal-layers.svg b/src/content/concepts/layer/oscal-layers.svg → ...resources/concepts/layer/oscal-layers.svg
diff --git a/src/content/concepts/layer/overview.md → ...tent/resources/concepts/layer/overview.md b/src/content/concepts/layer/overview.md → ...tent/resources/concepts/layer/overview.md
@@ -10,6 +10,7 @@ sidenav:
 aliases:
   - /documentation/schema/model-concepts/
   - /documentation/schema/overview/
+  - /concepts/overview/
 ---
 
 OSCAL is organized in a series of **layers** that each provide a set of **models**.

diff --git a/src/content/concepts/processing/_index.md → ...t/resources/concepts/processing/_index.md b/src/content/concepts/processing/_index.md → ...t/resources/concepts/processing/_index.md
@@ -5,6 +5,7 @@ description: Standardized processes to be applied to OSCAL data
 aliases:
   - /documentation/specification/
   - /documentation/processing/
+  - /concepts/processing/
 suppresstopiclist: true
 ---
 

diff --git a/...ncepts/processing/profile-resolution.html → ...ncepts/processing/profile-resolution.html b/...ncepts/processing/profile-resolution.html → ...ncepts/processing/profile-resolution.html
diff --git a/src/content/concepts/relations-to-other.md → .../resources/concepts/relations-to-other.md b/src/content/concepts/relations-to-other.md → .../resources/concepts/relations-to-other.md
@@ -7,6 +7,7 @@ toc:
 aliases:
   - /docs/relations/
   - /documentation/relations-to-other/
+  - /concepts/relations-to-other/
 ---
 
 Professionals working in the security domain are already familiar with numerous standards, specifications, guidelines and regulatory frameworks that define and describe practice in the systems security arena: NIST SP800-53, ISO 27002, FedRAMP, FISMA/FIPS, HIPAA and others. OSCAL's models are designed to capture the full range of these.

diff --git a/src/content/concepts/terminology/_index.md → .../resources/concepts/terminology/_index.md b/src/content/concepts/terminology/_index.md → .../resources/concepts/terminology/_index.md
@@ -14,6 +14,7 @@ aliases:
  - /learnmore/concepts/catalog/
  - /learnmore/concepts/profile/
  - /documentation/concepts/
+ - /concepts/terminology/
 ---
 
 This page reviews the many concepts and terms used in OSCAL, and is organized by the corresponding OSCAL layer where a given concept is first introduced.

diff --git a/...ofile-catalog-mapping-trivial-example.png → ...ofile-catalog-mapping-trivial-example.png b/...ofile-catalog-mapping-trivial-example.png → ...ofile-catalog-mapping-trivial-example.png
diff --git a/src/content/concepts/validation/_index.md → ...t/resources/concepts/validation/_index.md b/src/content/concepts/validation/_index.md → ...t/resources/concepts/validation/_index.md
@@ -6,6 +6,7 @@ aliases: []
 suppresstopiclist: true
 aliases:
 - /concepts/layer/validation/
+- /concepts/validation/
 ---
 
 ## Who is this document for?

diff --git a/...pts/validation/oscal-wellformed-valid.svg → ...pts/validation/oscal-wellformed-valid.svg b/...pts/validation/oscal-wellformed-valid.svg → ...pts/validation/oscal-wellformed-valid.svg
diff --git a/src/content/downloads/_index.md → src/content/resources/downloads/_index.md b/src/content/downloads/_index.md → src/content/resources/downloads/_index.md
@@ -1,13 +1,9 @@
 ---
 title: "Downloads"
-menu:
-  primary:
-    name: Downloads
-    weight: 40
 toc:
   enabled: true
 aliases:
-  - /resources/
+  - /downloads/
   - /downloads/other-resources/
 ---
 

diff --git a/src/content/examples/_index.md → src/content/resources/examples/_index.md b/src/content/examples/_index.md → src/content/resources/examples/_index.md
@@ -1,12 +1,10 @@
 ---
 title: Examples
 heading: OSCAL Examples
-menu:
-  primary:
-    name: Examples
-    weight: 50
 toc:
   enabled: true
+aliases:
+  - /examples/
 ---
 
 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.

diff --git a/src/content/reference/_index.md → src/content/resources/reference/_index.md b/src/content/reference/_index.md → src/content/resources/reference/_index.md
@@ -3,6 +3,8 @@ title: OSCAL Reference
 heading: OSCAL Reference (Moved)
 toc:
   enabled: false
+aliases:
+  - /reference/
 ---
 
 <br/><br/><br/>

diff --git a/src/content/tools/_index.md → src/content/resources/tools/_index.md b/src/content/tools/_index.md → src/content/resources/tools/_index.md
@@ -1,12 +1,10 @@
 ---
 title: Tools
 heading: OSCAL Tools
-menu:
-  primary:
-    name: Tools
-    weight: 50
 toc:
   enabled: true
+aliases:
+  - /tools/
 ---
 
 The [OSCAL models](/concepts/layer/) provide standardized formats for exchanging control, control implementation, and control assessment information in XML, JSON, and YAML, in support of interoperable security assessment automation and continuous monitoring. These formats allow this information to be exchanged between tools ensuring interoperability, and for individual tools, to process exchanged data, supporting analytics, user interaction, and security assessment automation where suitable.