Skip to content

Commit 0329364

Browse files
authored
Style the admonitions (#210)
* Style admonishments for better visibility Signed-off-by: Ben Cotton <ben@kusari.dev> * Fix the admonition in the rc Signed-off-by: Ben Cotton <ben@kusari.dev> * Add an admonition removal step to the release checklist Signed-off-by: Ben Cotton <ben@kusari.dev> --------- Signed-off-by: Ben Cotton <ben@kusari.dev>
1 parent 8c23075 commit 0329364

File tree

4 files changed

+26
-3
lines changed

4 files changed

+26
-3
lines changed

.github/ISSUE_TEMPLATE/release.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ body:
2323
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)
2424
- label: |
2525
In the `docs/versions/<VERSION>.md` file, change the `Version: devel` to have the version number of the new version
26+
- label: |
27+
In the `docs/versions/<VERSION>.md` file, remove the "not for production use" warning
2628
- label: |
2729
Move the link to the "current" version in `docs/index.md` to the "previous versions" list
2830
- label: |

cmd/template.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# Open Source Project Security Baseline
22

3-
Version: devel (not for production use)
3+
Version: devel
4+
5+
{: .warning}
6+
Not for production use.
47

58
<!-- A button for returning to the top of the page -->
69
<button onclick="toTop()" id="topButton" title="Go to top"

docs/assets/css/style.scss

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
---
3+
4+
@import "{{ site.theme }}";
5+
6+
.warning {
7+
background: rgba(114, 83, 237, 0.2);
8+
border-left: 4px solid #381885;
9+
border-radius: 4px;
10+
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08);
11+
padding: .8rem;
12+
}
13+
14+
.warning::before {
15+
font-weight: bold;
16+
font-size: 80%;
17+
content: "WARNING ";
18+
}

docs/versions/2025-02-25-rc.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Open Source Project Security Baseline - v2025-02-25-rc
22

3-
> [!WARNING]
4-
> This is a release candidate, not intended for production use.
3+
{: .warning }
4+
This is a release candidate, not intended for production use.
55

66
<button onclick="toTop()" id="topButton" title="Go to top"
77
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>

0 commit comments

Comments
 (0)