chore(docs): change structure of tutorials

Signed-off-by: Chris Butler <chris.butler@redhat.com>
oscal-compass · Sep 28, 2024 · ce156aa · ce156aa
1 parent 31c09a3
commit ce156aa
Show file tree

Hide file tree

Showing 59 changed files with 150 additions and 36 deletions.
diff --git a/docs/assets/favicon.ico b/docs/assets/favicon.ico
diff --git 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
@@ -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
@@ -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 → docs/contributing/code_of_conduct.md b/docs/mkdocs_code_of_conduct.md → 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
@@ -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
@@ -0,0 +1,6 @@
+---
+title: Overview
+description: BANANAS
+---
+
+{\!CONTRIBUTING.md!}
diff --git a/docs/contributing/maintainers.md 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
diff --git a/...ontributing/trestle_oscal_object_model.md → docs/contributing/oscal_object_model.md b/...ontributing/trestle_oscal_object_model.md → 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
@@ -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
@@ -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 → docs/demos.md b/docs/demonstrations-content.md → 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
@@ -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 → docs/installation.md b/docs/python_trestle_setup.md → 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 → docs/known_limitations.md b/docs/errors.md → 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
@@ -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
diff --git a/docs/plugins/compliance-trestle-fedramp.md → docs/plugins/fedramp.md b/docs/plugins/compliance-trestle-fedramp.md → 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
@@ -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/...rofile-to-oscal-catalog/transformation.md → ...asks/OCP4_CIS_profile_to_oscal_catalog.md b/...rofile-to-oscal-catalog/transformation.md → ...asks/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/...-ocp4-cis-profile-to-oscal-catalog.config → ...-ocp4-cis-profile-to-oscal-catalog.config b/...-ocp4-cis-profile-to-oscal-catalog.config → ...-ocp4-cis-profile-to-oscal-catalog.config
diff --git a/...cis-profile-to-oscal-cd/transformation.md → ...and_Tasks/OCP4_CIS_profile_to_oscal_cd.md b/...cis-profile-to-oscal-cd/transformation.md → ...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/.../demo-ocp4-cis-profile-to-oscal-cd.config → .../demo-ocp4-cis-profile-to-oscal-cd.config b/.../demo-ocp4-cis-profile-to-oscal-cd.config → .../demo-ocp4-cis-profile-to-oscal-cd.config
diff --git a/...is-profile-to-oscal-cd/enabled_rules.json → ...IS_profile_to_oscal_cd/enabled_rules.json b/...is-profile-to-oscal-cd/enabled_rules.json → ...IS_profile_to_oscal_cd/enabled_rules.json
diff --git a/...s-profile-to-oscal-cd/selected_rules.json → ...S_profile_to_oscal_cd/selected_rules.json b/...s-profile-to-oscal-cd/selected_rules.json → ...S_profile_to_oscal_cd/selected_rules.json
diff --git a/...nium-result-to-oscal-ar/transformation.md → ...rs_and_Tasks/Tanium_result_to_oscal_ar.md b/...nium-result-to-oscal-ar/transformation.md → ...rs_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/...carsdale_nimons_bridge.copyright-info.txt → ...carsdale_nimons_bridge.copyright-info.txt b/...carsdale_nimons_bridge.copyright-info.txt → ...carsdale_nimons_bridge.copyright-info.txt
diff --git a/...0px-Australia_scarsdale_nimons_bridge.jpg → ...0px-Australia_scarsdale_nimons_bridge.jpg b/...0px-Australia_scarsdale_nimons_bridge.jpg → ...0px-Australia_scarsdale_nimons_bridge.jpg
diff --git a/...ls/task.csv-to-oscal-cd/transformation.md → ...Transformers_and_Tasks/csv_to_oscal_cd.md b/...ls/task.csv-to-oscal-cd/transformation.md → ...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/...csv-to-oscal-cd/component-definition.json → ...csv_to_oscal_cd/component-definition.json b/...csv-to-oscal-cd/component-definition.json → ...csv_to_oscal_cd/component-definition.json
diff --git a/...v-to-oscal-cd/demo-csv-to-oscal-cd.config → ...v_to_oscal_cd/demo-csv-to-oscal-cd.config b/...v-to-oscal-cd/demo-csv-to-oscal-cd.config → ...v_to_oscal_cd/demo-csv-to-oscal-cd.config
diff --git a/...ask.csv-to-oscal-cd/ocp4-sample-input.csv → ...sks/csv_to_oscal_cd/ocp4-sample-input.csv b/...ask.csv-to-oscal-cd/ocp4-sample-input.csv → ...sks/csv_to_oscal_cd/ocp4-sample-input.csv
diff --git a/...-construction/transformer-construction.md → ...ers_and_Tasks/transformer_construction.md b/...-construction/transformer-construction.md → ...ers_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/...-construction/assessment-results-nist.png → ..._construction/assessment-results-nist.png b/...-construction/assessment-results-nist.png → ..._construction/assessment-results-nist.png
diff --git a/...er-construction/assessment-results.drawio → ...er_construction/assessment-results.drawio b/...er-construction/assessment-results.drawio → ...er_construction/assessment-results.drawio
diff --git a/...ormer-construction/assessment-results.jpg → ...ormer_construction/assessment-results.jpg b/...ormer-construction/assessment-results.jpg → ...ormer_construction/assessment-results.jpg
diff --git a/...struction/transformer-construction.drawio → ...struction/transformer-construction.drawio b/...struction/transformer-construction.drawio → ...struction/transformer-construction.drawio
diff --git a/...construction/transformer-construction.jpg → ...construction/transformer-construction.jpg b/...construction/transformer-construction.jpg → ...construction/transformer-construction.jpg
diff --git a/...uthoring/ssp_profile_catalog_authoring.md → ...uthoring/ssp_profile_catalog_authoring.md b/...uthoring/ssp_profile_catalog_authoring.md → ...uthoring/ssp_profile_catalog_authoring.md
diff --git a/...g/complex_resolved_profile_catalog.drawio → ...g/complex_resolved_profile_catalog.drawio b/...g/complex_resolved_profile_catalog.drawio → ...g/complex_resolved_profile_catalog.drawio
diff --git a/...ring/complex_resolved_profile_catalog.png → ...ring/complex_resolved_profile_catalog.png b/...ring/complex_resolved_profile_catalog.png → ...ring/complex_resolved_profile_catalog.png
diff --git a/...ile_catalog_authoring/profile_does.drawio → ...ile_catalog_authoring/profile_does.drawio b/...ile_catalog_authoring/profile_does.drawio → ...ile_catalog_authoring/profile_does.drawio
diff --git a/...rofile_catalog_authoring/profile_does.png → ...rofile_catalog_authoring/profile_does.png b/...rofile_catalog_authoring/profile_does.png → ...rofile_catalog_authoring/profile_does.png
diff --git a/...authoring/resolved_profile_catalog.drawio → ...authoring/resolved_profile_catalog.drawio b/...authoring/resolved_profile_catalog.drawio → ...authoring/resolved_profile_catalog.drawio
diff --git a/...og_authoring/resolved_profile_catalog.png → ...og_authoring/resolved_profile_catalog.png b/...og_authoring/resolved_profile_catalog.png → ...og_authoring/resolved_profile_catalog.png
diff --git a/...authoring/resolved_profile_diagram.drawio → ...authoring/resolved_profile_diagram.drawio b/...authoring/resolved_profile_diagram.drawio → ...authoring/resolved_profile_diagram.drawio
diff --git a/...og_authoring/resolved_profile_diagram.png → ...og_authoring/resolved_profile_diagram.png b/...og_authoring/resolved_profile_diagram.png → ...og_authoring/resolved_profile_diagram.png
diff --git a/...e_catalog_authoring/simple_catalog.drawio → ...e_catalog_authoring/simple_catalog.drawio b/...e_catalog_authoring/simple_catalog.drawio → ...e_catalog_authoring/simple_catalog.drawio
diff --git a/...file_catalog_authoring/simple_catalog.png → ...file_catalog_authoring/simple_catalog.png b/...file_catalog_authoring/simple_catalog.png → ...file_catalog_authoring/simple_catalog.png
diff --git a/...atalog_authoring/ssp_profile_options.docx → ...atalog_authoring/ssp_profile_options.docx b/...atalog_authoring/ssp_profile_options.docx → ...atalog_authoring/ssp_profile_options.docx
diff --git a/..._authoring/trestle_ssp_author_options.png → ..._authoring/trestle_ssp_author_options.png b/..._authoring/trestle_ssp_author_options.png → ..._authoring/trestle_ssp_author_options.png
diff --git a/docs/trestle_author.md → ...rials/Trestle Authoring/trestle_author.md b/docs/trestle_author.md → ...rials/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 → ...Trestle Authoring/trestle_author_jinja.md b/docs/trestle_author_jinja.md → ...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/...nuous-compliance/continuous-compliance.md → docs/tutorials/compliance_posture.md b/...nuous-compliance/continuous-compliance.md → 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/...us-compliance/ContinuousCompliance.drawio → ...iance_posture/ContinuousCompliance.drawio b/...us-compliance/ContinuousCompliance.drawio → ...iance_posture/ContinuousCompliance.drawio
diff --git a/...nuous-compliance/ContinuousCompliance.jpg → ...mpliance_posture/ContinuousCompliance.jpg b/...nuous-compliance/ContinuousCompliance.jpg → ...mpliance_posture/ContinuousCompliance.jpg
diff --git a/docs/tutorials/trestle_sample_workflow.md → docs/tutorials/introduction_to_trestle.md b/docs/tutorials/trestle_sample_workflow.md → 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
@@ -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