initial cleanup and formatting

rancherfederal · Feb 9, 2024 · e896d41 · e896d41
1 parent 2f8af15
commit e896d41
Show file tree

Hide file tree

Showing 35 changed files with 527 additions and 9,461 deletions.
diff --git a/Makefile b/Makefile
@@ -1,12 +1,37 @@
+# makefile for carbide-docs
+
+# set the port
 PORT:= 3000
 
+# docker build for carbide docs
 build:
 	docker rm --force carbide-docs; docker build -t carbide-docs -f Dockerfile.local .
-run: 
+
+# docker run for carbide-docs
+run:
 	docker run -p ${PORT}:3000 --name=carbide-docs -ti carbide-docs; docker logs -f carbide-docs
 
-local:
-	npm start
+# run all build commands
+local-all: local-install local-build local-serve
+
+# install dependencies
+local-install:
+	npm install
 
+# test and run carbide-docs
+# opens localhost:3000/carbide-docs
+local-test:
+	npm run start
+
+# build and compile carbide-docs
 local-build:
 	npm run build
+
+# server carbide-docs from build
+# opens localhost:5000/carbide-docs
+local-serve:
+	npm run serve
+
+# clear build outputs
+clear:
+	npm run clear && rm -rf node_modules
diff --git a/blog/2019-05-28-first-blog-post.md b/blog/2019-05-28-first-blog-post.md
diff --git a/blog/2019-05-29-long-blog-post.md b/blog/2019-05-29-long-blog-post.md
diff --git a/blog/2021-08-01-mdx-blog-post.mdx b/blog/2021-08-01-mdx-blog-post.mdx
diff --git a/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg b/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg
diff --git a/blog/2021-08-26-welcome/index.md b/blog/2021-08-26-welcome/index.md
diff --git a/blog/authors.yml b/blog/authors.yml
diff --git a/docs/airgapped-docs/introduction.md b/docs/airgapped-docs/introduction.md
@@ -1,13 +1,13 @@
 # Introduction
 
-This page will walk through Installation and Usage of the Airgapped Docs component of RGS Carbide.
+This page will walk through installation and usage of the Airgapped Docs component of Rancher Government Carbide.
 
 ## IOC Expectations
 As our product is still at Initial Operation Capability (IOC), there are some expectations to level-set:
 
 * Installation and packaging is still in progress and improving.
 
-If you see issues and areas for improvement, please submit Github issues [here](https://github.com/rancherfederal/ssf-feedback/issues/).
+If you see issues and areas for improvement, please submit Github issues [here](https://github.com/rancherfederal/carbide-charts/issues/).
 
 ## What is this?
 When in an airgap, having accessibility to documentation can be critical to mission success, especially while troubleshooting problems.

diff --git a/docs/airgapped-docs/prereqs.md b/docs/airgapped-docs/prereqs.md
@@ -1,7 +1,9 @@
 # Prerequisites
 
-In order to install STIGATRON, you need the following:
+In order to utilize Airgapped Docs, you will need the following prerequisites:
 
-* For pulling/storing the STIGATRON images in your registry, you'll need the [Cosign CLI](https://github.com/sigstore/cosign).
-* For installation, you'll need the [Helm CLI](https://helm.sh/docs/intro/install/).
-* From the Rancher Manager UI, access to the downstream RKE2 cluster(s) you want to install Airgapped Docs onto.
+- **Rancher v2.7.0 or higher:** https://ranchermanager.docs.rancher.com/integrations-in-rancher/rancher-extensions
+- For fetching and packaging... **Hauler:** https://github.com/rancherfederal/hauler
+- For installation and deployment... **Helm:** https://helm.sh/docs/intro/install
+- Access to the `local` cluster, to be able to install and deploy the app(s).
+- Access to the `downstream` cluster(s), to be able to install and deploy the app(s).
diff --git a/docs/feedback.md b/docs/feedback.md
@@ -0,0 +1,5 @@
+# Feedback
+
+Feedback is **critical** to us to continue to improve our tools and help you with your mission.
+
+For any issues, concerns, or questions, please open an issue: https://github.com/rancherfederal/carbide-docs/issues
diff --git a/docs/intro.md b/docs/intro.md
@@ -2,9 +2,9 @@
 sidebar_position: 1
 ---
 
-# Carbide
+# Introduction
 
-Carbide is Rancher Government's hardened distribution of the SUSE Rancher product portfolio. Carbide is exclusively offered to our US Government and partnering customers that value security above all else. 
+Carbide is Rancher Government's hardened distribution of the SUSE Rancher product portfolio. Carbide is exclusively offered to our US Government and partnering customers that value security above all else.
 
 Rancher Carbide is tactically built with the following enhancements over the community version:
 * [SLSA 3 compliant](https://slsa.dev/) secure build process hosted on Azure Government
@@ -13,7 +13,7 @@ Rancher Carbide is tactically built with the following enhancements over the com
 * Container [Attestations](https://www.testifysec.com/blog/what-is-a-supply-chain-attestation/)
 * Container Vulnerability Scans
 * Authenticated Registry hosted on Azure Government Container Registry
-* STIGATRON: Day 2 security operator powered by Rancher Government's DISA STIGs 
+* STIGATRON: Day 2 security operator powered by Rancher Government's DISA STIGs
 * Airgapped Docs: Fully airgapped-supportive documentation for the entire supported Rancher product portfolio
 * Custom red-white-blue theming & Rancher manager white-labeling
 

diff --git a/docs/registry-docs/known-limits.md → docs/known-limits.md b/docs/registry-docs/known-limits.md → docs/known-limits.md
diff --git a/docs/registry-docs/architecture.md b/docs/registry-docs/architecture.md
@@ -1,11 +1,11 @@
 # Architecture
 
-This page will walk through the architecture of the SSF, including both the pipelines as well as typical usage of the SSF images.
+This page will walk through the architecture of the Carbide Secured Registry (CSR), including both of the pipelines related to the CSR, as well as typical usage of the images.
 
 ## Pipeline Architecture
 
-![Pipeline Architecture](/img/ssf/ssf-pipelines-arch-diagram.svg)
+![Pipeline Architecture](/img/csr/csr-pipelines-arch-diagram.svg)
 
 ## Usage Architecture
 
-![Usage Architecture](/img/ssf/ssf-usage-arch-diagram.svg)
+![Usage Architecture](/img/csr/csr-usage-arch-diagram.svg)
diff --git a/docs/registry-docs/copying-images.md b/docs/registry-docs/copying-images.md
@@ -1,4 +1,4 @@
-# Copy Release Images to Registry
+# Copying Images to a Registry
 
 This page will walk you through how you can copy the secured images from the hardened registry into another registry within a connected environment.
 
@@ -187,7 +187,7 @@ TARGET_REGISTRY=YOUR_REGISTRY_DOMAIN_HERE
 # cosign login -u YOUR_USER -p YOUR_PASSWORD $TARGET_REGISTRY
 
 # Set the specific release of Rancher you're targeting: https://github.com/rancher/rancher/releases
-RANCHER_RELEASE=v2.7.1
+RANCHER_RELEASE=v2.8.2
 
 RANCHER_IMAGES=$(curl --silent -L https://github.com/rancher/rancher/releases/download/$RANCHER_RELEASE/rancher-images.txt)
 for image in $RANCHER_IMAGES; do