From e56b42692292dc68511cc95d94388858bb90a33b Mon Sep 17 00:00:00 2001 From: Simon Essien Date: Mon, 3 Aug 2026 14:43:20 +0100 Subject: [PATCH] feat: pull community page content from README via include-markdown Signed-off-by: Simon Essien --- docs/community.md | 102 +++------------------------------------------- mkdocs.yml | 1 + requirements.txt | 1 + 3 files changed, 7 insertions(+), 97 deletions(-) diff --git a/docs/community.md b/docs/community.md index 8124e7b..e21c5e7 100644 --- a/docs/community.md +++ b/docs/community.md @@ -1,99 +1,7 @@ # OSCAL Compass Logo **OSCAL Compass Community** -## Welcome to the OSCAL Compass Community - -The OSCAL Compass project is a set of tools that enable the creation, validation, and governance of documentation artifacts for compliance needs. It leverages NIST's OSCAL ([Open Security Controls Assessment Language](https://pages.nist.gov/OSCAL/)) as a standard data format for interchange between tools and people, and provides an opinionated approach to OSCAL adoption. - -OSCAL Compass is made up of several projects with different release cycles. Collectively, these enable end-to-end automation of various compliance processes. This repository shares OSCAL Compass's activity and collaboration details across the community and include the most current information about the project. - -Contributing new features, resolving bugs and issues, and refining the documentation experience through pull requests are welcome. More information about contributing to the OSCAL Compass projects, contributor roles, governance and legal, and licenses can be found in proceeding sections of this document. - -## Community Goals - -The goals of this open source community includes the following: - -- Drive adoption of the OSCAL standard using Trestle, Agile Authoring, and C2P tools for end-to-end compliance automation. -- Come up with use-cases for automating compliance processes in an organization and the required tooling support. -- Influence the OSCAL standard based on the requirements and use-cases identified. - - -## Learn about the projects - -[Trestle](https://github.com/oscal-compass/compliance-trestle) - -Trestle is an ensemble of tools that enable the creation, validation, and governance of documentation artifacts for compliance needs. It leverages NIST's OSCAL as a standard data format for interchange between tools and people, and provides an opinionated approach to OSCAL adoption. - -Trestle is designed to operate as a CI/CD pipeline running on top of compliance artifacts in git, to provide transparency for the state of compliance across multiple stakeholders in an environment friendly to developers. Trestle passes the generated artifacts onto tools that orchestrate the enforcement, measurement, and reporting of compliance. - -[Agile Authoring](https://github.com/oscal-compass/compliance-trestle-agile-authoring) - -Agile Authoring is a collaborative platform enabling various compliance personas to orchestrate their individual aspects of the compliance artifacts via an interface of their choice. It is a Trestle-based GitOps automated workflow and ensures artifacts consistency and traceability. It provides ready to use CI/CD pipeline configuration and setup using a GitOps approach with Trestle for OSCAL document management and collaboration. - -[Compliance to Policy](https://github.com/oscal-compass/compliance-to-policy) (aka C2P) - -Compliance-to-Policy (C2P) bridges Compliance as Code and Policy as Code. C2P takes Compliance requirements and generates technical policies for Policy Validation Points (PVPs), and takes PVP native results and generates Compliance Assessment Results. C2P reduces the cost to implement the interchange between Compliance artifacts and PVP proprietary artifacts. C2P is extensible to various PVPs through plugin. - -### Video Introduction - - - Watch the video - - -## Community meetings and communications - -### Scheduled meetings - -Please attend! All are invited. - -| | When | Where | -| -------- | ------- | -------- | -| **Global** | Every other Tuesday starting on April 23, 2024 · 11:00 – 12:00pm ET [convert to your local time.](https://mytime.io/11am/ET) | [Zoom](https://zoom-lfx.platform.linuxfoundation.org/meeting/91709345128?password=5510325d-895f-4932-a843-df728dc3028d) | -| **APAC friendly** | Every other following Thursday starting on November 30, 2024 - 05:00 GMT / 16:00 AEDT / 1030 IST [convert to your local time.](https://mytime.io/5am/GMT) |[Zoom](https://zoom-lfx.platform.linuxfoundation.org/meeting/97945872533?password=abad1bfe-cc9a-49d8-9aa6-99bb469a434d) | - - -Meeting agenda and notes [Google Docs](https://docs.google.com/document/d/1XTYM7xnWlIqd-8Nn5-qtgvgk8kH3NSmYle5yZvaS7qs/edit?usp=sharing) - -We also have a [shared calendar](https://zoom-lfx.platform.linuxfoundation.org/meetings/trestlegrc?view=week). - -**Recordings** - -All of our meeting recordings are available for review on our YouTube [channel](https://www.youtube.com/@OSCAL-Compass). - -### Email - -Google Group: [oscal-compass](https://groups.google.com/g/oscal-compass)\ -oscal-compass@googlegroups.com - -### Chat anytime - -Slack: [#oscal-compass-trestle-agileauthoring-c2p](https://cloud-native.slack.com/archives/C06F3PEPNBW) - -- **Note**: You can login to Slack using another account like Google, Apple - -## Contributions - -Our project welcomes external contributions. Please consult [contributing](https://github.com/oscal-compass/community/blob/main/CONTRIBUTING.md) to get started. - -## License & Authors - -If you would like to see the detailed LICENSE click [here](https://github.com/oscal-compass/community/blob/main/LICENSE). -Consult [maintainers](https://github.com/oscal-compass/community/blob/main/MAINTAINERS.md) for the current list of maintainers for various projects in the oscal-compass community. - -```text -# Copyright (c) 2025 The OSCAL Compass Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -``` - ------ +{% + include-markdown "https://raw.githubusercontent.com/oscal-compass/community/main/README.md" + start="## Welcome to the OSCAL Compass Community" + rewrite-relative-urls=false +%} diff --git a/mkdocs.yml b/mkdocs.yml index 3bc4a74..9f7cf69 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,6 +7,7 @@ site_url: https://oscal-compass.dev plugins: - search - awesome-pages + - include-markdown theme: name: material custom_dir: custom_theme/ diff --git a/requirements.txt b/requirements.txt index a06b3eb..194a9bd 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,3 @@ mkdocs-material>=9.6.0 mkdocs-awesome-pages-plugin>=2.10.0 +mkdocs-include-markdown-plugin>=7.3.0