diff --git a/docs/assets/favicon.ico b/docs/assets/favicon.ico new file mode 100644 index 000000000..fc00960cc Binary files /dev/null and b/docs/assets/favicon.ico differ diff --git a/docs/cli.md b/docs/cli.md index bd44ac92e..593ff3b6c 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -1,3 +1,8 @@ +--- +title: +description: BANANAS +--- + # trestle CLI Overview and OSCAL Usecases The trestle CLI has three primary use cases: diff --git a/docs/contributing/.pages b/docs/contributing/.pages new file mode 100644 index 000000000..545a6ae75 --- /dev/null +++ b/docs/contributing/.pages @@ -0,0 +1,10 @@ +nav: +- Overview: index.md +- Code of Conduct: code_of_conduct.md +- OSCAL object model: oscal_object_model.md +- Website development: website.md +- Developing trestle plugins: plugins.md +- Contributors: https://github.com/oscal-compass/compliance-trestle/graphs/contributors +- Maintainers: maintainers.md +- Developer Certificate of Originality: DCO.md +- GitHub actions: github_actions_setup.md diff --git a/docs/contributing/DCO.md b/docs/contributing/DCO.md index 72e24098f..2287b50b5 100644 --- a/docs/contributing/DCO.md +++ b/docs/contributing/DCO.md @@ -1,3 +1,10 @@ +--- +title: Developer Certificate of Originality +description: BANANAS +--- + +In order to insure proper attribution contributors must use `git --signoff` on commits. + ```text Developer Certificate of Origin Version 1.1 diff --git a/docs/mkdocs_code_of_conduct.md b/docs/contributing/code_of_conduct.md similarity index 57% rename from docs/mkdocs_code_of_conduct.md rename to docs/contributing/code_of_conduct.md index 1d4307950..565995067 100644 --- a/docs/mkdocs_code_of_conduct.md +++ b/docs/contributing/code_of_conduct.md @@ -1,4 +1,8 @@ -# Code of Conduct +--- +title: Code of conduct +description: BANANAS # potentially replace with a +--- +# Code of Conduct Please refer to our [OSCAL Compass Community Code of Conduct](https://github.com/oscal-compass/community/blob/main/CODE_OF_CONDUCT.md). diff --git a/docs/contributing/github_actions_setup.md b/docs/contributing/github_actions_setup.md index 8cf0bbb8f..f737f4f10 100644 --- a/docs/contributing/github_actions_setup.md +++ b/docs/contributing/github_actions_setup.md @@ -1,3 +1,8 @@ +--- +title: Setting up GitHub actions +description: BANANAS +--- + # Github actions setup Github actions contains variables which have opaque values to a user. diff --git a/docs/contributing/index.md b/docs/contributing/index.md new file mode 100644 index 000000000..b2190d737 --- /dev/null +++ b/docs/contributing/index.md @@ -0,0 +1,6 @@ +--- +title: Overview +description: BANANAS +--- + +{\!CONTRIBUTING.md!} diff --git a/docs/contributing/maintainers.md b/docs/contributing/maintainers.md new file mode 100644 index 000000000..813dece00 --- /dev/null +++ b/docs/contributing/maintainers.md @@ -0,0 +1,6 @@ +--- +title: Maintainers +description: BANANAS +--- + +{\!MAINTAINERS.md!} diff --git a/docs/contributing/mkdocs_contributing.md b/docs/contributing/mkdocs_contributing.md deleted file mode 100644 index 66e8e2b46..000000000 --- a/docs/contributing/mkdocs_contributing.md +++ /dev/null @@ -1 +0,0 @@ -{!CONTRIBUTING.md!} diff --git a/docs/contributing/trestle_oscal_object_model.md b/docs/contributing/oscal_object_model.md similarity index 99% rename from docs/contributing/trestle_oscal_object_model.md rename to docs/contributing/oscal_object_model.md index a77b47a4f..6be2534ef 100644 --- a/docs/contributing/trestle_oscal_object_model.md +++ b/docs/contributing/oscal_object_model.md @@ -1,3 +1,8 @@ +--- +title: +description: BANANAS +--- + # Using trestle as an object model for OSCAL Trestle provides an object model for OSCAL to ease the development and validation of OSCAL objects that reside in the `trestle.oscal` module. diff --git a/docs/contributing/plugins.md b/docs/contributing/plugins.md index f4f7d6582..8fd972a14 100644 --- a/docs/contributing/plugins.md +++ b/docs/contributing/plugins.md @@ -1,3 +1,8 @@ +--- +title: Developing trestle plugins +description: BANANAS +--- + # Adding plugins to trestle Trestle provides a mechanism for 3rd party providers to extend its command interface via a plugin architecture. All trestle plugins that conforms to this specification will be automatically discovered by trestle if installed, and their command(s) will be added to trestle sub-commands list. Below we describe this plugin mechanism with the help of an example plugin [`compliance-trestle-fedramp`](https://github.com/oscal-compass/compliance-trestle-fedramp) that we created as a separate python project that can be installed via `pip`. diff --git a/docs/contributing/website.md b/docs/contributing/website.md index 4dfbbc7c4..1b68b11c9 100644 --- a/docs/contributing/website.md +++ b/docs/contributing/website.md @@ -1,3 +1,8 @@ +--- +title: +description: BANANAS +--- + # Developing for the trestle documentation website This page describes the developing for the trestle (website) which is deployed at https://oscal-compass.github.io/compliance-trestle. diff --git a/docs/demonstrations-content.md b/docs/demos.md similarity index 98% rename from docs/demonstrations-content.md rename to docs/demos.md index c2059d9ce..07d47178e 100644 --- a/docs/demonstrations-content.md +++ b/docs/demos.md @@ -1,3 +1,8 @@ +--- +title: Demos +description: BANANAS +--- + # Trestle demonstration projects and content Trestle has a number of demonstrations setup in the diff --git a/docs/index.md b/docs/index.md index 3759cecaf..6d9ab7e1b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,8 @@ +--- +title: Overview +description: BANANAS +--- + # Compliance-trestle (also known as `trestle`) ![[OS Compatibility](#prerequisites)](https://img.shields.io/badge/platform-osx%20%7C%20linux%20%7C%20windows-orange.svg) diff --git a/docs/python_trestle_setup.md b/docs/installation.md similarity index 98% rename from docs/python_trestle_setup.md rename to docs/installation.md index c1853c7a1..846ec5ccb 100644 --- a/docs/python_trestle_setup.md +++ b/docs/installation.md @@ -1,3 +1,8 @@ +--- +title: Installation +description: BANANAS +--- + # Install trestle in a python virtual environment There are a few things you need to to start using trestle: diff --git a/docs/errors.md b/docs/known_limitations.md similarity index 90% rename from docs/errors.md rename to docs/known_limitations.md index 510451def..dda0c2187 100644 --- a/docs/errors.md +++ b/docs/known_limitations.md @@ -1,3 +1,8 @@ +--- +title: Known Limitations +description: BANANAS +--- + # Known errors and limitations ## utf-8 encoding only diff --git a/docs/license.md b/docs/license.md index 20d02241d..38199a08e 100644 --- a/docs/license.md +++ b/docs/license.md @@ -1,3 +1,8 @@ +--- +title: License +description: BANANAS +--- + ```text Apache License Version 2.0, January 2004 diff --git a/docs/maintainers.md b/docs/maintainers.md deleted file mode 100644 index c279e3448..000000000 --- a/docs/maintainers.md +++ /dev/null @@ -1 +0,0 @@ -{!MAINTAINERS.md!} diff --git a/docs/plugins/compliance-trestle-fedramp.md b/docs/plugins/fedramp.md similarity index 97% rename from docs/plugins/compliance-trestle-fedramp.md rename to docs/plugins/fedramp.md index 843039eef..0771d2577 100644 --- a/docs/plugins/compliance-trestle-fedramp.md +++ b/docs/plugins/fedramp.md @@ -1,3 +1,8 @@ +--- +title: FedRAMP plugin +description: BANANAS +--- + # compliance-trestle-fedramp plugin This plugin provides functionality for validating an SSP for FedRAMP compliance. It provides both an API interface and a trestle command for performing this validation. diff --git a/docs/reference/third-party-result-schema-SCC.md b/docs/reference/third-party-result-schema-SCC.md index 57dddbaac..50bf79a82 100644 --- a/docs/reference/third-party-result-schema-SCC.md +++ b/docs/reference/third-party-result-schema-SCC.md @@ -1,3 +1,8 @@ +--- +title: +description: BANANAS +--- + # Schema of Assessment Results for Interchange with IBM Cloud Security and Compliance Center, SCC This document depicts the structure and guidelines for creating an OSCAL result object which would be generated by various transformers for different tools such as Tanium to OSCAL and OSCO to OSCAL. Policy Validation Points (PVPs) such as toolchain that directly generate OSCAL results for sending to SCC Exchange API should follow the structure and guidelines described below. diff --git a/docs/tutorials/task.ocp4-cis-profile-to-oscal-catalog/transformation.md b/docs/tutorials/Transformers_and_Tasks/OCP4_CIS_profile_to_oscal_catalog.md similarity index 99% rename from docs/tutorials/task.ocp4-cis-profile-to-oscal-catalog/transformation.md rename to docs/tutorials/Transformers_and_Tasks/OCP4_CIS_profile_to_oscal_catalog.md index 00a669a2e..25ce78ccb 100644 --- a/docs/tutorials/task.ocp4-cis-profile-to-oscal-catalog/transformation.md +++ b/docs/tutorials/Transformers_and_Tasks/OCP4_CIS_profile_to_oscal_catalog.md @@ -1,3 +1,8 @@ +--- +title: +description: BANANAS +--- + # Tutorial: Setup for and use of ComplianceAsCode profile to OSCAL Catalog transformer Here are step by step instructions for setup and transformation of [ComplianceAsCode](https://github.com/ComplianceAsCode/content) profile data files into [NIST](https://www.nist.gov/) standard [OSCAL](https://pages.nist.gov/OSCAL/) [Catalog](https://pages.nist.gov/OSCAL-Reference/models/latest/catalog/json-outline/) using the [compliance-trestle](../../index.md) tool. diff --git a/docs/tutorials/task.ocp4-cis-profile-to-oscal-catalog/demo-ocp4-cis-profile-to-oscal-catalog.config b/docs/tutorials/Transformers_and_Tasks/OCP4_CIS_profile_to_oscal_catalog/demo-ocp4-cis-profile-to-oscal-catalog.config similarity index 100% rename from docs/tutorials/task.ocp4-cis-profile-to-oscal-catalog/demo-ocp4-cis-profile-to-oscal-catalog.config rename to docs/tutorials/Transformers_and_Tasks/OCP4_CIS_profile_to_oscal_catalog/demo-ocp4-cis-profile-to-oscal-catalog.config diff --git a/docs/tutorials/task.ocp4-cis-profile-to-oscal-cd/transformation.md b/docs/tutorials/Transformers_and_Tasks/OCP4_CIS_profile_to_oscal_cd.md similarity index 99% rename from docs/tutorials/task.ocp4-cis-profile-to-oscal-cd/transformation.md rename to docs/tutorials/Transformers_and_Tasks/OCP4_CIS_profile_to_oscal_cd.md index 58dcef079..c467ceeca 100644 --- a/docs/tutorials/task.ocp4-cis-profile-to-oscal-cd/transformation.md +++ b/docs/tutorials/Transformers_and_Tasks/OCP4_CIS_profile_to_oscal_cd.md @@ -1,3 +1,8 @@ +--- +title: +description: BANANAS +--- + # Tutorial: Setup for and use of ComplianceAsCode profile to OSCAL Component Definition transformer Here are step by step instructions for setup and transformation of [ComplianceAsCode](https://github.com/ComplianceAsCode/content) profile data files into [NIST](https://www.nist.gov/) standard [OSCAL](https://pages.nist.gov/OSCAL/) [Component Definition](https://pages.nist.gov/OSCAL-Reference/models/v1.1.2/complete/json-reference/#/component-definition) using the [compliance-trestle](https://oscal-compass.github.io/compliance-trestle/) tool. diff --git a/docs/tutorials/task.ocp4-cis-profile-to-oscal-cd/demo-ocp4-cis-profile-to-oscal-cd.config b/docs/tutorials/Transformers_and_Tasks/OCP4_CIS_profile_to_oscal_cd/demo-ocp4-cis-profile-to-oscal-cd.config similarity index 100% rename from docs/tutorials/task.ocp4-cis-profile-to-oscal-cd/demo-ocp4-cis-profile-to-oscal-cd.config rename to docs/tutorials/Transformers_and_Tasks/OCP4_CIS_profile_to_oscal_cd/demo-ocp4-cis-profile-to-oscal-cd.config diff --git a/docs/tutorials/task.ocp4-cis-profile-to-oscal-cd/enabled_rules.json b/docs/tutorials/Transformers_and_Tasks/OCP4_CIS_profile_to_oscal_cd/enabled_rules.json similarity index 100% rename from docs/tutorials/task.ocp4-cis-profile-to-oscal-cd/enabled_rules.json rename to docs/tutorials/Transformers_and_Tasks/OCP4_CIS_profile_to_oscal_cd/enabled_rules.json diff --git a/docs/tutorials/task.ocp4-cis-profile-to-oscal-cd/selected_rules.json b/docs/tutorials/Transformers_and_Tasks/OCP4_CIS_profile_to_oscal_cd/selected_rules.json similarity index 100% rename from docs/tutorials/task.ocp4-cis-profile-to-oscal-cd/selected_rules.json rename to docs/tutorials/Transformers_and_Tasks/OCP4_CIS_profile_to_oscal_cd/selected_rules.json diff --git a/docs/tutorials/task.tanium-result-to-oscal-ar/transformation.md b/docs/tutorials/Transformers_and_Tasks/Tanium_result_to_oscal_ar.md similarity index 99% rename from docs/tutorials/task.tanium-result-to-oscal-ar/transformation.md rename to docs/tutorials/Transformers_and_Tasks/Tanium_result_to_oscal_ar.md index 844984619..f6b0c2199 100644 --- a/docs/tutorials/task.tanium-result-to-oscal-ar/transformation.md +++ b/docs/tutorials/Transformers_and_Tasks/Tanium_result_to_oscal_ar.md @@ -1,3 +1,8 @@ +--- +title: +description: BANANAS +--- + # Tutorial: Setup for and use of Tanium to OSCAL transformer Here are step by step instructions for setup and transformation of [Tanium](https://www.tanium.com/) compliance data files into [NIST](https://www.nist.gov/) standard [OSCAL](https://pages.nist.gov/OSCAL/) using the [compliance-trestle](https://oscal-compass.github.io/compliance-trestle/) tool. diff --git a/docs/tutorials/task.tanium-result-to-oscal-ar/800px-Australia_scarsdale_nimons_bridge.copyright-info.txt b/docs/tutorials/Transformers_and_Tasks/Tanium_result_to_oscal_ar/800px-Australia_scarsdale_nimons_bridge.copyright-info.txt similarity index 100% rename from docs/tutorials/task.tanium-result-to-oscal-ar/800px-Australia_scarsdale_nimons_bridge.copyright-info.txt rename to docs/tutorials/Transformers_and_Tasks/Tanium_result_to_oscal_ar/800px-Australia_scarsdale_nimons_bridge.copyright-info.txt diff --git a/docs/tutorials/task.tanium-result-to-oscal-ar/800px-Australia_scarsdale_nimons_bridge.jpg b/docs/tutorials/Transformers_and_Tasks/Tanium_result_to_oscal_ar/800px-Australia_scarsdale_nimons_bridge.jpg similarity index 100% rename from docs/tutorials/task.tanium-result-to-oscal-ar/800px-Australia_scarsdale_nimons_bridge.jpg rename to docs/tutorials/Transformers_and_Tasks/Tanium_result_to_oscal_ar/800px-Australia_scarsdale_nimons_bridge.jpg diff --git a/docs/tutorials/task.csv-to-oscal-cd/transformation.md b/docs/tutorials/Transformers_and_Tasks/csv_to_oscal_cd.md similarity index 99% rename from docs/tutorials/task.csv-to-oscal-cd/transformation.md rename to docs/tutorials/Transformers_and_Tasks/csv_to_oscal_cd.md index 304b21abf..91efb5542 100644 --- a/docs/tutorials/task.csv-to-oscal-cd/transformation.md +++ b/docs/tutorials/Transformers_and_Tasks/csv_to_oscal_cd.md @@ -1,3 +1,8 @@ +--- +title: Converting +description: BANANAS +--- + # Tutorial: Setup for and use of standard format csv-file to OSCAL Component Definition json-file transformer Here are step by step instructions for setup and transformation of [trestle standard format csv-file](ocp4-sample-input.csv) into OSCAL Component Definition [json-file](component-definition.json) using the [compliance-trestle](https://oscal-compass.github.io/compliance-trestle/) tool. diff --git a/docs/tutorials/task.csv-to-oscal-cd/component-definition.json b/docs/tutorials/Transformers_and_Tasks/csv_to_oscal_cd/component-definition.json similarity index 100% rename from docs/tutorials/task.csv-to-oscal-cd/component-definition.json rename to docs/tutorials/Transformers_and_Tasks/csv_to_oscal_cd/component-definition.json diff --git a/docs/tutorials/task.csv-to-oscal-cd/demo-csv-to-oscal-cd.config b/docs/tutorials/Transformers_and_Tasks/csv_to_oscal_cd/demo-csv-to-oscal-cd.config similarity index 100% rename from docs/tutorials/task.csv-to-oscal-cd/demo-csv-to-oscal-cd.config rename to docs/tutorials/Transformers_and_Tasks/csv_to_oscal_cd/demo-csv-to-oscal-cd.config diff --git a/docs/tutorials/task.csv-to-oscal-cd/ocp4-sample-input.csv b/docs/tutorials/Transformers_and_Tasks/csv_to_oscal_cd/ocp4-sample-input.csv similarity index 100% rename from docs/tutorials/task.csv-to-oscal-cd/ocp4-sample-input.csv rename to docs/tutorials/Transformers_and_Tasks/csv_to_oscal_cd/ocp4-sample-input.csv diff --git a/docs/tutorials/task.transformer-construction/transformer-construction.md b/docs/tutorials/Transformers_and_Tasks/transformer_construction.md similarity index 99% rename from docs/tutorials/task.transformer-construction/transformer-construction.md rename to docs/tutorials/Transformers_and_Tasks/transformer_construction.md index e5573cd5e..90ab6e13a 100644 --- a/docs/tutorials/task.transformer-construction/transformer-construction.md +++ b/docs/tutorials/Transformers_and_Tasks/transformer_construction.md @@ -1,3 +1,8 @@ +--- +title: +description: BANANAS +--- + # Tutorial: How to build an Oscal Assessment Results "lite" with Trestle SDK from your posture result format The compliance-trestle (trestle) project provides helpful modules to assist your standardization efforts. diff --git a/docs/tutorials/task.transformer-construction/assessment-results-nist.png b/docs/tutorials/Transformers_and_Tasks/transformer_construction/assessment-results-nist.png similarity index 100% rename from docs/tutorials/task.transformer-construction/assessment-results-nist.png rename to docs/tutorials/Transformers_and_Tasks/transformer_construction/assessment-results-nist.png diff --git a/docs/tutorials/task.transformer-construction/assessment-results.drawio b/docs/tutorials/Transformers_and_Tasks/transformer_construction/assessment-results.drawio similarity index 100% rename from docs/tutorials/task.transformer-construction/assessment-results.drawio rename to docs/tutorials/Transformers_and_Tasks/transformer_construction/assessment-results.drawio diff --git a/docs/tutorials/task.transformer-construction/assessment-results.jpg b/docs/tutorials/Transformers_and_Tasks/transformer_construction/assessment-results.jpg similarity index 100% rename from docs/tutorials/task.transformer-construction/assessment-results.jpg rename to docs/tutorials/Transformers_and_Tasks/transformer_construction/assessment-results.jpg diff --git a/docs/tutorials/task.transformer-construction/transformer-construction.drawio b/docs/tutorials/Transformers_and_Tasks/transformer_construction/transformer-construction.drawio similarity index 100% rename from docs/tutorials/task.transformer-construction/transformer-construction.drawio rename to docs/tutorials/Transformers_and_Tasks/transformer_construction/transformer-construction.drawio diff --git a/docs/tutorials/task.transformer-construction/transformer-construction.jpg b/docs/tutorials/Transformers_and_Tasks/transformer_construction/transformer-construction.jpg similarity index 100% rename from docs/tutorials/task.transformer-construction/transformer-construction.jpg rename to docs/tutorials/Transformers_and_Tasks/transformer_construction/transformer-construction.jpg diff --git a/docs/tutorials/ssp_profile_catalog_authoring/ssp_profile_catalog_authoring.md b/docs/tutorials/Trestle Authoring/ssp_profile_catalog_authoring.md similarity index 100% rename from docs/tutorials/ssp_profile_catalog_authoring/ssp_profile_catalog_authoring.md rename to docs/tutorials/Trestle Authoring/ssp_profile_catalog_authoring.md diff --git a/docs/tutorials/ssp_profile_catalog_authoring/complex_resolved_profile_catalog.drawio b/docs/tutorials/Trestle Authoring/ssp_profile_catalog_authoring/complex_resolved_profile_catalog.drawio similarity index 100% rename from docs/tutorials/ssp_profile_catalog_authoring/complex_resolved_profile_catalog.drawio rename to docs/tutorials/Trestle Authoring/ssp_profile_catalog_authoring/complex_resolved_profile_catalog.drawio diff --git a/docs/tutorials/ssp_profile_catalog_authoring/complex_resolved_profile_catalog.png b/docs/tutorials/Trestle Authoring/ssp_profile_catalog_authoring/complex_resolved_profile_catalog.png similarity index 100% rename from docs/tutorials/ssp_profile_catalog_authoring/complex_resolved_profile_catalog.png rename to docs/tutorials/Trestle Authoring/ssp_profile_catalog_authoring/complex_resolved_profile_catalog.png diff --git a/docs/tutorials/ssp_profile_catalog_authoring/profile_does.drawio b/docs/tutorials/Trestle Authoring/ssp_profile_catalog_authoring/profile_does.drawio similarity index 100% rename from docs/tutorials/ssp_profile_catalog_authoring/profile_does.drawio rename to docs/tutorials/Trestle Authoring/ssp_profile_catalog_authoring/profile_does.drawio diff --git a/docs/tutorials/ssp_profile_catalog_authoring/profile_does.png b/docs/tutorials/Trestle Authoring/ssp_profile_catalog_authoring/profile_does.png similarity index 100% rename from docs/tutorials/ssp_profile_catalog_authoring/profile_does.png rename to docs/tutorials/Trestle Authoring/ssp_profile_catalog_authoring/profile_does.png diff --git a/docs/tutorials/ssp_profile_catalog_authoring/resolved_profile_catalog.drawio b/docs/tutorials/Trestle Authoring/ssp_profile_catalog_authoring/resolved_profile_catalog.drawio similarity index 100% rename from docs/tutorials/ssp_profile_catalog_authoring/resolved_profile_catalog.drawio rename to docs/tutorials/Trestle Authoring/ssp_profile_catalog_authoring/resolved_profile_catalog.drawio diff --git a/docs/tutorials/ssp_profile_catalog_authoring/resolved_profile_catalog.png b/docs/tutorials/Trestle Authoring/ssp_profile_catalog_authoring/resolved_profile_catalog.png similarity index 100% rename from docs/tutorials/ssp_profile_catalog_authoring/resolved_profile_catalog.png rename to docs/tutorials/Trestle Authoring/ssp_profile_catalog_authoring/resolved_profile_catalog.png diff --git a/docs/tutorials/ssp_profile_catalog_authoring/resolved_profile_diagram.drawio b/docs/tutorials/Trestle Authoring/ssp_profile_catalog_authoring/resolved_profile_diagram.drawio similarity index 100% rename from docs/tutorials/ssp_profile_catalog_authoring/resolved_profile_diagram.drawio rename to docs/tutorials/Trestle Authoring/ssp_profile_catalog_authoring/resolved_profile_diagram.drawio diff --git a/docs/tutorials/ssp_profile_catalog_authoring/resolved_profile_diagram.png b/docs/tutorials/Trestle Authoring/ssp_profile_catalog_authoring/resolved_profile_diagram.png similarity index 100% rename from docs/tutorials/ssp_profile_catalog_authoring/resolved_profile_diagram.png rename to docs/tutorials/Trestle Authoring/ssp_profile_catalog_authoring/resolved_profile_diagram.png diff --git a/docs/tutorials/ssp_profile_catalog_authoring/simple_catalog.drawio b/docs/tutorials/Trestle Authoring/ssp_profile_catalog_authoring/simple_catalog.drawio similarity index 100% rename from docs/tutorials/ssp_profile_catalog_authoring/simple_catalog.drawio rename to docs/tutorials/Trestle Authoring/ssp_profile_catalog_authoring/simple_catalog.drawio diff --git a/docs/tutorials/ssp_profile_catalog_authoring/simple_catalog.png b/docs/tutorials/Trestle Authoring/ssp_profile_catalog_authoring/simple_catalog.png similarity index 100% rename from docs/tutorials/ssp_profile_catalog_authoring/simple_catalog.png rename to docs/tutorials/Trestle Authoring/ssp_profile_catalog_authoring/simple_catalog.png diff --git a/docs/tutorials/ssp_profile_catalog_authoring/ssp_profile_options.docx b/docs/tutorials/Trestle Authoring/ssp_profile_catalog_authoring/ssp_profile_options.docx similarity index 100% rename from docs/tutorials/ssp_profile_catalog_authoring/ssp_profile_options.docx rename to docs/tutorials/Trestle Authoring/ssp_profile_catalog_authoring/ssp_profile_options.docx diff --git a/docs/tutorials/ssp_profile_catalog_authoring/trestle_ssp_author_options.png b/docs/tutorials/Trestle Authoring/ssp_profile_catalog_authoring/trestle_ssp_author_options.png similarity index 100% rename from docs/tutorials/ssp_profile_catalog_authoring/trestle_ssp_author_options.png rename to docs/tutorials/Trestle Authoring/ssp_profile_catalog_authoring/trestle_ssp_author_options.png diff --git a/docs/trestle_author.md b/docs/tutorials/Trestle Authoring/trestle_author.md similarity index 99% rename from docs/trestle_author.md rename to docs/tutorials/Trestle Authoring/trestle_author.md index e69dfb393..4e04d548b 100644 --- a/docs/trestle_author.md +++ b/docs/tutorials/Trestle Authoring/trestle_author.md @@ -1,3 +1,8 @@ +--- +title: Governance of Authored Documents +description: BANANAS +--- + # Trestle CLI for Governance of Authored Documents This document is organized in a multiple collapsable sections for ease of use. diff --git a/docs/trestle_author_jinja.md b/docs/tutorials/Trestle Authoring/trestle_author_jinja.md similarity index 99% rename from docs/trestle_author_jinja.md rename to docs/tutorials/Trestle Authoring/trestle_author_jinja.md index 45001f513..801a20fb3 100644 --- a/docs/trestle_author_jinja.md +++ b/docs/tutorials/Trestle Authoring/trestle_author_jinja.md @@ -1,3 +1,8 @@ +--- +title: +description: BANANAS +--- + # Trestle author jinja - output templating support for oscal documents. Unfortunately OSCAL documents are not yet universally accepted. Therefore to support various OSCAL and non-OSCAL compliance workflows `trestle author jinja` is designed to provide end users with the ability to use jinja to produce customized output. This complements the more structured commands `trestle author catalog-{assemble|generate}`, `trestle author profile-{assemble|generate}` and `trestle author ssp-{assemble|generate}` and allows arbitrary use of jinja. diff --git a/docs/tutorials/continuous-compliance/continuous-compliance.md b/docs/tutorials/compliance_posture.md similarity index 86% rename from docs/tutorials/continuous-compliance/continuous-compliance.md rename to docs/tutorials/compliance_posture.md index a8f5b0c8c..294281f5d 100644 --- a/docs/tutorials/continuous-compliance/continuous-compliance.md +++ b/docs/tutorials/compliance_posture.md @@ -1,3 +1,8 @@ +--- +title: +description: BANANAS +--- + # Tutorial: What’s your compliance posture? #### Introduction @@ -17,15 +22,15 @@ Moreover, assuring continuous compliance across multiple cloud vendors can compl Common sense dictates that standardization would simplify matters. The National Institute of Standards and Technologies (NIST) is developing the Open Security Controls Assessment Language ([OSCAL](https://pages.nist.gov/OSCAL)). -The compliance-[trestle](../../index.md) open source github project is an effort to employ [OSCAL](https://pages.nist.gov/OSCAL) for compliance standardization and automation. Of great utility is the [trestle](../../index.md) oscal module that facilitates transformation of data to/from Python object representations in accordance with the [OSCAL](https://pages.nist.gov/OSCAL) schemas. +The compliance-[trestle](../index.md) open source github project is an effort to employ [OSCAL](https://pages.nist.gov/OSCAL) for compliance standardization and automation. Of great utility is the [trestle](../index.md) oscal module that facilitates transformation of data to/from Python object representations in accordance with the [OSCAL](https://pages.nist.gov/OSCAL) schemas. #### Simple Continuous Compliance Architecture -![Continuous Compliance Reporting](ContinuousCompliance.jpg) +![Continuous Compliance Reporting](./compliance_posture/ContinuousCompliance.jpg) Cloud Services can often be configured to monitor (and sometimes enforce) policies. Examples include OpenShift Compliance Operator and Tanium. However, the compliance reporting “raw” data produced is unique to each. -Two steps are needed to ascertain your compliance posture. Step 1 is to transform available compliance “raw” data into standardized form ([OSCAL](https://pages.nist.gov/OSCAL)). Step 2 is to examine the [OSCAL](https://pages.nist.gov/OSCAL) data and assemble a compliance posture for the controls and components of interest. And [trestle](../../index.md) is the go-to solution. +Two steps are needed to ascertain your compliance posture. Step 1 is to transform available compliance “raw” data into standardized form ([OSCAL](https://pages.nist.gov/OSCAL)). Step 2 is to examine the [OSCAL](https://pages.nist.gov/OSCAL) data and assemble a compliance posture for the controls and components of interest. And [trestle](../index.md) is the go-to solution. #### Step 1 – Transformation @@ -35,7 +40,7 @@ However, there is plenty of good news: - a transformer for your Cloud Service type may already exist, such as: [Tanium to OSCAL](https://github.com/oscal-compass/compliance-trestle/blob/main/trestle/tasks/tanium_result_to_oscal_ar.py), [OpenShift Compliance Operator to OSCAL](https://github.com/oscal-compass/compliance-trestle/blob/main/trestle/tasks/xccdf_result_to_oscal_ar.py) - once a transformer for a Cloud Service type has been written, it can be open-sourced/re-used -- writing a transformer is fairly easy: just a few lines of Python code using [trestle](../../index.md) as a foundation +- writing a transformer is fairly easy: just a few lines of Python code using [trestle](../index.md) as a foundation In the case of Tanium, the [OSCAL](https://pages.nist.gov/OSCAL) compliance data document is a *System Assessment Results* fragment with *Findings* and *Observations*, while in the case of OpenShift Compliance Operator there are *Observations* only. diff --git a/docs/tutorials/continuous-compliance/ContinuousCompliance.drawio b/docs/tutorials/compliance_posture/ContinuousCompliance.drawio similarity index 100% rename from docs/tutorials/continuous-compliance/ContinuousCompliance.drawio rename to docs/tutorials/compliance_posture/ContinuousCompliance.drawio diff --git a/docs/tutorials/continuous-compliance/ContinuousCompliance.jpg b/docs/tutorials/compliance_posture/ContinuousCompliance.jpg similarity index 100% rename from docs/tutorials/continuous-compliance/ContinuousCompliance.jpg rename to docs/tutorials/compliance_posture/ContinuousCompliance.jpg diff --git a/docs/tutorials/trestle_sample_workflow.md b/docs/tutorials/introduction_to_trestle.md similarity index 99% rename from docs/tutorials/trestle_sample_workflow.md rename to docs/tutorials/introduction_to_trestle.md index 5e9bcfdee..395d9935c 100644 --- a/docs/tutorials/trestle_sample_workflow.md +++ b/docs/tutorials/introduction_to_trestle.md @@ -1,3 +1,8 @@ +--- +title: Introduction to trestle workflows +description: BANANAS +--- + # Tutorial: Introduction to trestle workflow Here are step-by-step instructions to manipulate a [NIST](https://www.nist.gov/) standard [OSCAL](https://pages.nist.gov/OSCAL/) catalog using the [compliance-trestle](https://oscal-compass.github.io/compliance-trestle/) (`"trestle"`) tool. diff --git a/mkdocs.yml b/mkdocs.yml index 9a7d7bf0c..601248e88 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -22,38 +22,12 @@ markdown_extensions: - toc: permalink: ¤ nav: -- Overview: index.md -- Installation: python_trestle_setup.md +- Overview: index.md # OKAY +- Installation: python_trestle_setup.md # OKAy - Tutorials: - - Intro to trestle workflow: tutorials/trestle_sample_workflow.md - - Compliance posture: tutorials/continuous-compliance/continuous-compliance.md - - Trestle Authoring: - - Governance of Authored Documents: trestle_author.md - - Catalog, Profile, ComponentDefinition, and SSP Authoring: tutorials/ssp_profile_catalog_authoring/ssp_profile_catalog_authoring.md - - Trestle Transformers and Tasks: - - Transformer construction: tutorials/task.transformer-construction/transformer-construction.md - - Task - task.csv-to-oscal-cd: tutorials/task.csv-to-oscal-cd/transformation.md - - Task - ocp4-cis-profile-to-oscal-catalog: tutorials/task.ocp4-cis-profile-to-oscal-catalog/transformation.md - - Task - ocp4-cis-profile-to-oscal-cd: tutorials/task.ocp4-cis-profile-to-oscal-cd/transformation.md - - Task - tanium-result-to-oscal-ar: tutorials/task.tanium-result-to-oscal-ar/transformation.md - Trestle command-line interface (CLI): - CLI for OSCAL documents: cli.md - CLI for Jinja Template processing: trestle_author_jinja.md -- Contributing: - - Code of Conduct: mkdocs_code_of_conduct.md - - Contributing overview: contributing/mkdocs_contributing.md - - Contributors: https://github.com/oscal-compass/compliance-trestle/graphs/contributors - - Maintainers: maintainers.md - - Documentation website: contributing/website.md - - Trestle's object model: contributing/trestle_oscal_object_model.md - - Developer Certificate of Originality: contributing/DCO.md - - Trestle plugin mechanism: contributing/plugins.md - - GitHub actions setup: contributing/github_actions_setup.md -- Known limitations: errors.md -- Demos: demonstrations-content.md -- Plugins: - - FedRAMP validation: plugins/compliance-trestle-fedramp.md -- License: license.md - Reference: - Integrating with IBM SCC: reference/third-party-result-schema-SCC.md - trestle API reference: @@ -238,8 +212,12 @@ theme: name: material palette: accent: purple - primary: teal + primary: black scheme: slate + time_format: "%Y-%m-%d %H:%M:%S" # The format used to display the time + meta_time_format: "%Y-%m-%d %H:%M:%S" + logo: "../images/compliance-trestle-800x800-transparent.png" + favicon: assets/favicon.ico validation: omitted_files: warn absolute_links: warn # Or 'relative_to_docs' - new in MkDocs 1.6