docs: updates for new website

acrlabs · Feb 7, 2025 · 89358b7 · 89358b7
1 parent e658de8
commit 89358b7
Show file tree

Hide file tree

Showing 20 changed files with 11 additions and 77 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file.
 
 Breaking changes are annotated with the ⚠️ symbol.
 
-## [2.0.0] - 2024-11-20
+## v2.0.0 - 2024-11-20
 
 ### 🚀 Features
 
@@ -26,7 +26,7 @@ Breaking changes are annotated with the ⚠️ symbol.
 - Update tracer permissions to read-only
 - Don't set node-selector for sk-tracer in kustomize files
 
-## [1.1.1] - 2024-10-09
+## v1.1.1 - 2024-10-09
 
 ### 🐛 Bug Fixes
 
@@ -35,7 +35,7 @@ Breaking changes are annotated with the ⚠️ symbol.
 - Regression on deleting objects in the simulated environment
 - Handle local paths without `file:///`
 
-## [1.1.0] - 2024-10-01
+## v1.1.0 - 2024-10-01
 
 ### 🚀 Features
 
@@ -45,12 +45,12 @@ Breaking changes are annotated with the ⚠️ symbol.
 
 - Split kustomize components into prod and sim clusters
 
-## [1.0.1] - 2024-09-16
+## v1.0.1 - 2024-09-16
 
 ### 🐛 Bug Fixes
 
 - Use forked `parse_datetime` crate to correctly handle local/UTC time zones
 
-## [1.0.0] - 2024-09-05
+## v1.0.0 - 2024-09-05
 
 <!-- generated by git-cliff -->
diff --git a/cliff.toml b/cliff.toml
@@ -16,7 +16,7 @@ Breaking changes are annotated with the ⚠️ symbol.
 # https://keats.github.io/tera/docs/#introduction
 body = """
 {% if version %}\
-    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+    ## {{version}} - {{ timestamp | date(format="%Y-%m-%d") }}
 {% else %}\
     ## [unreleased]
 {% endif %}\
@@ -35,14 +35,6 @@ footer = """
 """
 # remove the leading and trailing s
 trim = true
-# postprocessors
-postprocessors = [
-  # { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL
-]
-# render body even when there are no releases to process
-# render_always = true
-# output file path
-# output = "test.md"
 
 [git]
 # parse the commits based on https://www.conventionalcommits.org

diff --git a/docs/adv/autoscaling.md b/docs/adv/autoscaling.md
@@ -1,5 +1,4 @@
 <!--
-project: SimKube
 template: docs.html
 -->
 

diff --git a/docs/adv/config.md b/docs/adv/config.md
@@ -1,5 +1,4 @@
 <!--
-project: SimKube
 template: docs.html
 -->
 

diff --git a/docs/adv/hooks.md b/docs/adv/hooks.md
@@ -1,5 +1,4 @@
 <!--
-project: SimKube
 template: docs.html
 -->
 

diff --git a/docs/adv/metrics.md b/docs/adv/metrics.md
@@ -1,5 +1,4 @@
 <!--
-project: SimKube
 template: docs.html
 -->
 

diff --git a/docs/adv/traces.md b/docs/adv/traces.md
@@ -1,5 +1,4 @@
 <!--
-project: SimKube
 template: docs.html
 -->
 

diff --git a/docs/components/sk-ctrl.md b/docs/components/sk-ctrl.md
@@ -1,5 +1,4 @@
 <!--
-project: SimKube
 template: docs.html
 -->
 

diff --git a/docs/components/sk-driver.md b/docs/components/sk-driver.md
@@ -1,5 +1,4 @@
 <!--
-project: SimKube
 template: docs.html
 -->
 

diff --git a/docs/components/sk-tracer.md b/docs/components/sk-tracer.md
@@ -1,5 +1,4 @@
 <!--
-project: SimKube
 template: docs.html
 -->
 

diff --git a/docs/components/skctl.md b/docs/components/skctl.md
@@ -1,5 +1,4 @@
 <!--
-project: SimKube
 template: docs.html
 -->
 

diff --git a/docs/dev/api_changes.md b/docs/dev/api_changes.md
@@ -1,5 +1,4 @@
 <!--
-project: SimKube
 template: docs.html
 -->
 

diff --git a/docs/dev/contributing.md b/docs/dev/contributing.md
@@ -1,5 +1,4 @@
 <!--
-project: SimKube
 template: docs.html
 -->
 
@@ -140,6 +139,11 @@ instead with an optional `testutils` feature.
 
 ## Making a PR
 
+> [!WARNING]
+> Due to the uncertain nature of copyright and IP law, this repository does not accept contributions that have been all
+> or partially generated with GitHub Copilot or other LLM-based code generation tools.  Please disable any such tools
+> before authoring changes to this project.
+
 Follow the standard process for opening a pull request.  Please provide a nice description of your contribution.  GitHub
 actions will run tests, linting, and build.  If there are any errors there, please fix them!  Once your tests are
 passing, one of the maintainers will sign off on the PR and merge it to master.
diff --git a/docs/dev/setup.md b/docs/dev/setup.md
@@ -1,5 +1,4 @@
 <!--
-project: SimKube
 template: docs.html
 -->
 

diff --git a/docs/faq.md b/docs/faq.md
diff --git a/docs/images/sk-overview.png b/docs/images/sk-overview.png
diff --git a/docs/intro/concepts.md b/docs/intro/concepts.md
@@ -1,5 +1,4 @@
 <!--
-project: SimKube
 template: docs.html
 -->
 

diff --git a/docs/intro/installation.md b/docs/intro/installation.md
@@ -1,5 +1,4 @@
 <!--
-project: SimKube
 template: docs.html
 -->
 

diff --git a/docs/intro/running.md b/docs/intro/running.md
@@ -1,5 +1,4 @@
 <!--
-project: SimKube
 template: docs.html
 -->
 

diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -1,7 +1,5 @@
 ---
 nav:
-  - Home: README.md
-  - FAQ: docs/faq.md
   - Getting Started:
       - Concepts: docs/intro/concepts.md
       - Installation: docs/intro/installation.md