Style the admonitions (#210)

* Style admonishments for better visibility Signed-off-by: Ben Cotton <[email protected]> * Fix the admonition in the rc Signed-off-by: Ben Cotton <[email protected]> * Add an admonition removal step to the release checklist Signed-off-by: Ben Cotton <[email protected]> --------- Signed-off-by: Ben Cotton <[email protected]>
ossf · Feb 24, 2025 · 0329364 · 0329364
1 parent 8c23075
commit 0329364
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 3 deletions.
diff --git a/.github/ISSUE_TEMPLATE/release.yaml b/.github/ISSUE_TEMPLATE/release.yaml
@@ -23,6 +23,8 @@ body:
             Generate a static version of the baseline: `cd cmd && go run . compile --output ../docs/versions/2025-02-04.md` (replace `2025-02-04` with the version name)
         - label: |
             In the `docs/versions/<VERSION>.md` file, change the `Version: devel` to have the version number of the new version
+        - label: |
+            In the `docs/versions/<VERSION>.md` file, remove the "not for production use" warning
         - label: |
             Move the link to the "current" version in `docs/index.md` to the "previous versions" list
         - label: |

diff --git a/cmd/template.md b/cmd/template.md
@@ -1,6 +1,9 @@
 # Open Source Project Security Baseline
 
-Version: devel (not for production use)
+Version: devel
+
+{: .warning}
+Not for production use.
 
 <!-- A button for returning to the top of the page -->
 <button onclick="toTop()" id="topButton" title="Go to top"

diff --git a/docs/assets/css/style.scss b/docs/assets/css/style.scss
@@ -0,0 +1,18 @@
+---
+---
+
+@import "{{ site.theme }}";
+
+.warning {
+    background: rgba(114, 83, 237, 0.2);
+    border-left: 4px solid #381885;
+    border-radius: 4px;
+    box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08);
+    padding: .8rem;
+}
+
+.warning::before {
+    font-weight: bold;
+    font-size: 80%;
+    content: "WARNING ";
+}
diff --git a/docs/versions/2025-02-25-rc.md b/docs/versions/2025-02-25-rc.md
@@ -1,7 +1,7 @@
 # Open Source Project Security Baseline - v2025-02-25-rc
 
-> [!WARNING]
-> This is a release candidate, not intended for production use.
+{: .warning }
+This is a release candidate, not intended for production use.
 
 <button onclick="toTop()" id="topButton" title="Go to top"
 style="display: none; position: fixed; bottom: 20px; right: 30px; border: none; background-color: CornflowerBlue; color: white; cursor: pointer; padding: 10px; border-radius: 10px; font-size: 18px;">to top</button>