Add container and help wanted information

- Add pre-built container usage to README and landing page - Highlight RHEL10 and Ubuntu 24.04 pre-built content - Add Help Wanted sections with downloadable artifacts request - Fix documentation links in Contributing guide 🤖 Generated with Claude Code Co-Authored-By: Claude <[email protected]>
mitre · Feb 27, 2025 · 382ee0d · 382ee0d
1 parent 8fe1531
commit 382ee0d
Show file tree

Hide file tree

Showing 3 changed files with 87 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,25 @@
 
 This project provides Docker-based tooling for working with the [ComplianceAsCode/content](https://github.com/ComplianceAsCode/content) project, enabling easy generation of SCAP content for various platforms.
 
-## Quick Start
+## Pre-built Containers
+
+We provide ready-to-use container images on GitHub Container Registry:
+
+```bash
+# Pull the full version (with pre-built RHEL10 and Ubuntu 24.04)
+docker pull ghcr.io/mitre/cac-builder:full
+
+# Pull the minimal version (smaller size, build products on-demand)
+docker pull ghcr.io/mitre/cac-builder:minimal
+
+# Run the container
+docker run -it --name compliance-as-code -v $(pwd)/output:/output ghcr.io/mitre/cac-builder:full bash
+
+# Inside the container, the pre-built products are already available
+ls /content/build/
+```
+
+## Quick Start (Building Locally)
 
 ```bash
 # Setup the environment
@@ -19,7 +37,7 @@ docker exec -it compliance-as-code bash
 build-product rhel10
 ```
 
-For detailed setup instructions, see [Setting Up Your Local Development Environment](docs/setup-local-development.md).
+For detailed setup instructions, see our [documentation site](https://mitre.github.io/cac-builder/).
 
 ## Directory Structure
 
@@ -208,13 +226,27 @@ For details on certificate management, see [docs/CERTIFICATES.md](docs/CERTIFICA
 
 Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details and review our [Code of Conduct](CODE_OF_CONDUCT.md) before participating.
 
+## Help Wanted / Future Improvements
+
+We're looking for help with the following areas:
+
+- Additional product support beyond RHEL10 and Ubuntu 24.04
+- Performance improvements for build processes
+- Enhanced CI/CD integration examples
+- Additional documentation for advanced use cases
+- Multi-architecture container support
+- Creating downloadable build artifacts (zip/tar.gz of RHEL10 and Ubuntu 24.04 SCAP content) for the documentation site
+
+If you're interested in working on these or other improvements, please check our [open issues](https://github.com/mitre/cac-builder/issues) or create a new one to discuss your ideas.
+
 ## Development
 
 For developers looking to contribute or modify this project:
 
-- [Setup Local Development](docs/setup-local-development.md): Complete environment setup guide
-- [Local Development Workflow](docs/local-development.md): Development best practices
-- [Project Structure](PROJECT-STRUCTURE.md): Codebase organization
+- [Documentation Site](https://mitre.github.io/cac-builder/): Comprehensive project documentation
+- [Setup Local Development](https://mitre.github.io/cac-builder/getting-started/setup/): Complete environment setup guide
+- [Local Development Workflow](https://mitre.github.io/cac-builder/development/local-workflow/): Development best practices
+- [Project Structure](https://mitre.github.io/cac-builder/documentation/project-structure/): Codebase organization
 
 ## Notices
 

diff --git a/docs/development/contributing.md b/docs/development/contributing.md
@@ -11,11 +11,24 @@ Thank you for considering contributing to ComplianceAsCode Builder! This documen
 
 ## Code of Conduct
 
-Please be respectful and considerate of others when contributing to this project. We expect all contributors to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md).
+Please be respectful and considerate of others when contributing to this project. We expect all contributors to adhere to our [Code of Conduct]({{< relref "/development/code-of-conduct" >}}).
 
 ## Project Structure
 
-Before contributing, please familiarize yourself with the [project structure](PROJECT-STRUCTURE.md).
+Before contributing, please familiarize yourself with the [project structure]({{< relref "/documentation/project-structure" >}}).
+
+## Help Wanted
+
+We're currently looking for help with the following areas:
+
+- Additional product support beyond RHEL10 and Ubuntu 24.04
+- Performance improvements for build processes
+- Enhanced CI/CD integration examples
+- Additional documentation for advanced use cases
+- Multi-architecture container support
+- Creating downloadable build artifacts (zip/tar.gz of RHEL10 and Ubuntu 24.04 SCAP content) for the documentation site
+
+These areas are great places to start if you're looking to make a meaningful contribution to the project.
 
 ## How to Contribute
 

diff --git a/docs/index.md b/docs/index.md
@@ -9,15 +9,32 @@ permalink: /
 # ComplianceAsCode Builder
 {: .fs-9 }
 
-Docker-based tooling for working with the ComplianceAsCode/content project, enabling easy generation of SCAP content for various platforms.
+Docker-based tooling for working with the ComplianceAsCode/content project, enabling easy generation of SCAP content for various platforms. Pre-built containers include ready-to-use SCAP content for RHEL10 and Ubuntu 24.04.
 {: .fs-6 .fw-300 }
 
 [Get Started](/cac-builder/getting-started/){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 }
 [View on GitHub](https://github.com/mitre/cac-builder){: .btn .fs-5 .mb-4 .mb-md-0 }
 
 ---
 
-## Quick Start
+## Pre-built Containers
+
+We provide ready-to-use container images with pre-built SCAP content for RHEL10 and Ubuntu 24.04:
+
+```bash
+# Pull the full version (with pre-built content)
+docker pull ghcr.io/mitre/cac-builder:full
+
+# Run the container
+docker run -it --name compliance-as-code -v $(pwd)/output:/output ghcr.io/mitre/cac-builder:full bash
+
+# Inside the container, the pre-built products are already available
+ls /content/build/
+```
+
+## Build Locally
+
+If you prefer to build the container locally:
 
 ```bash
 # Setup the environment
@@ -65,4 +82,19 @@ GitHub Actions for automated builds, tests, and local workflow testing.
 
 ComplianceAsCode Builder is an open-source project that welcomes contributions from the community.
 
-[Contributing Guidelines](/cac-builder/development/contributing/){: .btn .btn-blue }
+[Contributing Guidelines](/cac-builder/development/contributing/){: .btn .btn-blue }
+
+## Help Wanted
+
+We're looking for contributors to help with:
+
+- Additional product support beyond RHEL10 and Ubuntu 24.04
+- Performance improvements for build processes
+- Enhanced CI/CD integration examples
+- Additional documentation for advanced use cases
+- Multi-architecture container support
+- Creating downloadable build artifacts (zip/tar.gz of RHEL10 and Ubuntu 24.04 SCAP content) for the documentation site
+
+If you're interested in working on these or other improvements, please check our [open issues](https://github.com/mitre/cac-builder/issues) or create a new one to discuss your ideas.
+
+[View Open Issues](https://github.com/mitre/cac-builder/issues){: .btn .btn-green }