docs: update README.md with new content
This commit is contained in:
Hernâni Marques
parent
c1fefcc766
commit
467092db1f
11 changed files with 133 additions and 60 deletions
|
|
@ -40,3 +40,47 @@ Hourly JSON can sit next to the HTML once the timer is installed on koopa
|
|||
|
||||
Hourly builder belongs in **kal** (this tree). Do **not** put
|
||||
`scripts/branch-status-hourly.py` back into tdpd.
|
||||
|
||||
## Sticky cascade bar
|
||||
|
||||
Stock Caddy `templates` renders `{% include "_cascade/bar.html" . %}` on each
|
||||
HTML page. The include path has no leading slash. The dot passes the request,
|
||||
so `.Req.URL.Path` marks the active link with `class="is-active"` and
|
||||
`aria-current="page"`. Delimiters are `{%` `%}`, so a later `{{ }}` in real
|
||||
dossier HTML stays literal.
|
||||
|
||||
The bar lists cascade `/` plus the five branch paths. Seeded tips match
|
||||
`branch-status.json`. `/_cascade/bar.js` refreshes `[data-tip]` from that JSON
|
||||
(`cache: no-store`). CSS is `/_cascade/bar.css` (`position: sticky`).
|
||||
|
||||
Enable templates before rsync. A page without the include does not grow the
|
||||
bar. `{%` without the templates directive is shown as raw text.
|
||||
|
||||
Templates apply is **host-local on koopa** (`~/bin/apply-dossiers-ngi-templates.sh`),
|
||||
not tracked in this repo. It edits `~/koopa-caddy/Caddyfile` only (this host;
|
||||
keeps `header Alt-Svc "clear"` and any `basic_auth`; leaves `.2` / `.3`
|
||||
untouched). Then reload with the usual home→`/etc` helper:
|
||||
|
||||
```bash
|
||||
bash ~/bin/apply-dossiers-ngi-templates.sh
|
||||
sudo ~/bin/caddy-apply
|
||||
```
|
||||
|
||||
The stanza body for hand-check / re-seed lives in
|
||||
`scripts/dossiers-ngi/caddy-dossiers-ngi.snippet`.
|
||||
`scripts/caddy/caddy-apply.sh --snippet` leaves an existing block unchanged.
|
||||
Leave `scripts/caddy/apply-goa-wdGet-full-replace.sh` and
|
||||
`scripts/caddy/apply-dossiers-ngi-basicauth.sh` unused. No response-body
|
||||
replace plugin.
|
||||
|
||||
After validate and reload succeed, rsync from the laptop (Freigabe):
|
||||
|
||||
```bash
|
||||
rsync -avz --delete --exclude .DS_Store \
|
||||
"$HOME/git/admin-logs/local/koopa-admin-log/sites/dossiers.ngi.hacktivism.ch/" \
|
||||
hernani@koopa:/var/www/monitoring-sites/dossiers.ngi.hacktivism.ch/
|
||||
```
|
||||
|
||||
`--delete` removes `_cascade/` on the server when the source tree is an older
|
||||
copy. The bar does not finish the dossier site. This section does not install
|
||||
the hourly timer.
|
||||
|
|
|
|||
19
scripts/dossiers-ngi/caddy-dossiers-ngi.snippet
Normal file
19
scripts/dossiers-ngi/caddy-dossiers-ngi.snippet
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
# Stanza body for dossiers.ngi.hacktivism.ch only (hand-check / re-seed).
|
||||
# Templates apply is host-local on koopa (not in this repo):
|
||||
# bash ~/bin/apply-dossiers-ngi-templates.sh
|
||||
# sudo ~/bin/caddy-apply
|
||||
#
|
||||
# Keep the existing line: header Alt-Svc "clear"
|
||||
# Keep any existing basic_auth in that same block.
|
||||
# scripts/caddy/caddy-apply.sh --snippet reports an existing block and
|
||||
# does not merge these lines. Leave that script unused for this change.
|
||||
# Leave scripts/caddy/apply-goa-wdGet-full-replace.sh unused.
|
||||
# Leave scripts/caddy/apply-dossiers-ngi-basicauth.sh unused.
|
||||
# Stock Caddy templates only. No replace-response plugin.
|
||||
#
|
||||
# Tab-indented lines inserted after header Alt-Svc:
|
||||
|
||||
templates {
|
||||
mime text/html
|
||||
between "{%" "%}"
|
||||
}
|
||||
29
sites/dossiers.ngi.hacktivism.ch/_cascade/bar.css
Normal file
29
sites/dossiers.ngi.hacktivism.ch/_cascade/bar.css
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
.cascade-bar {
|
||||
position: sticky;
|
||||
top: 0;
|
||||
z-index: 10;
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
gap: 0.35rem 0.85rem;
|
||||
align-items: baseline;
|
||||
margin: -1.5rem -1.5rem 1rem;
|
||||
padding: 0.55rem 1.5rem;
|
||||
background: #10141a;
|
||||
border-bottom: 1px solid #243040;
|
||||
}
|
||||
.cascade-bar a {
|
||||
color: #7ec8ff;
|
||||
text-decoration: none;
|
||||
}
|
||||
.cascade-bar a:hover { text-decoration: underline; }
|
||||
.cascade-bar a.is-active {
|
||||
color: #e8eef4;
|
||||
text-decoration: none;
|
||||
box-shadow: inset 0 -2px 0 #e8eef4;
|
||||
}
|
||||
.cascade-bar a.is-active:hover { text-decoration: none; }
|
||||
.cascade-bar code { color: inherit; }
|
||||
.cascade-bar .tip {
|
||||
color: #8a96a3;
|
||||
font-size: 12px;
|
||||
}
|
||||
11
sites/dossiers.ngi.hacktivism.ch/_cascade/bar.html
Normal file
11
sites/dossiers.ngi.hacktivism.ch/_cascade/bar.html
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
{% $p := .Req.URL.Path %}
|
||||
<link rel="stylesheet" href="/_cascade/bar.css">
|
||||
<nav class="cascade-bar" aria-label="cascade">
|
||||
<a href="/" {% if or (eq $p "/") (eq $p "/index.html") %}class="is-active" aria-current="page"{% end %}>cascade</a>
|
||||
<a href="/main/" {% if or (eq $p "/main") (or (eq $p "/main/") (eq $p "/main/index.html")) %}class="is-active" aria-current="page"{% end %}><code>/main/</code> <span class="tip" data-tip="main">main @ d2fbd79</span></a>
|
||||
<a href="/feat-sm-content/" {% if or (eq $p "/feat-sm-content") (or (eq $p "/feat-sm-content/") (eq $p "/feat-sm-content/index.html")) %}class="is-active" aria-current="page"{% end %}><code>/feat-sm-content/</code> <span class="tip" data-tip="feat/sm-content">feat/sm-content @ 089ef1f</span></a>
|
||||
<a href="/feat-website-features/" {% if or (eq $p "/feat-website-features") (or (eq $p "/feat-website-features/") (eq $p "/feat-website-features/index.html")) %}class="is-active" aria-current="page"{% end %}><code>/feat-website-features/</code> <span class="tip" data-tip="feat/website-features">feat/website-features @ 53a3176</span></a>
|
||||
<a href="/feat-website-design/" {% if or (eq $p "/feat-website-design") (or (eq $p "/feat-website-design/") (eq $p "/feat-website-design/index.html")) %}class="is-active" aria-current="page"{% end %}><code>/feat-website-design/</code> <span class="tip" data-tip="feat/website-design">feat/website-design @ 2e26c80</span></a>
|
||||
<a href="/feat-website-views/" {% if or (eq $p "/feat-website-views") (or (eq $p "/feat-website-views/") (eq $p "/feat-website-views/index.html")) %}class="is-active" aria-current="page"{% end %}><code>/feat-website-views/</code> <span class="tip" data-tip="feat/website-views">feat/website-views @ bbafc38</span></a>
|
||||
</nav>
|
||||
<script src="/_cascade/bar.js" defer></script>
|
||||
24
sites/dossiers.ngi.hacktivism.ch/_cascade/bar.js
Normal file
24
sites/dossiers.ngi.hacktivism.ch/_cascade/bar.js
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
(function () {
|
||||
var nodes = document.querySelectorAll(".cascade-bar [data-tip]");
|
||||
if (!nodes.length) return;
|
||||
fetch("/branch-status.json", { cache: "no-store" })
|
||||
.then(function (res) {
|
||||
if (!res.ok) throw new Error("status");
|
||||
return res.json();
|
||||
})
|
||||
.then(function (data) {
|
||||
var tips = {};
|
||||
var list = (data && data.branches) || [];
|
||||
for (var i = 0; i < list.length; i++) {
|
||||
var row = list[i];
|
||||
if (row && row.branch && row.tip) tips[row.branch] = row.tip;
|
||||
}
|
||||
for (var j = 0; j < nodes.length; j++) {
|
||||
var el = nodes[j];
|
||||
var name = el.getAttribute("data-tip");
|
||||
var tip = tips[name];
|
||||
if (tip) el.textContent = name + " @ " + tip;
|
||||
}
|
||||
})
|
||||
.catch(function () {});
|
||||
})();
|
||||
|
|
@ -17,8 +17,6 @@ a { color: #7ec8ff; text-decoration: none; }
|
|||
a:hover { text-decoration: underline; }
|
||||
h1 { font-size: 1.15rem; font-weight: 600; margin: 0 0 0.5rem; color: #e8eef4; }
|
||||
.meta { color: #8a96a3; margin: 0 0 1rem; }
|
||||
.nav { margin: 0.5rem 0 1rem; }
|
||||
.nav a { margin-right: 0.85rem; }
|
||||
ul.plain { padding-left: 1.2rem; margin: 0; }
|
||||
li { margin: 0.25rem 0; }
|
||||
.dim { color: #6a7682; }
|
||||
|
|
@ -26,15 +24,8 @@ li { margin: 0.25rem 0; }
|
|||
</style>
|
||||
</head>
|
||||
<body>
|
||||
{% include "_cascade/bar.html" . %}
|
||||
<h1><code>/feat-sm-content/</code></h1>
|
||||
<p class="meta">last-built: 2026-09-30T02:30:50+02:00 <span class="dim">·</span> <code>feat/sm-content</code> @ <code>089ef1f</code></p>
|
||||
<div class="nav">
|
||||
<a href="/">/</a>
|
||||
<a href="/main/">/main/</a>
|
||||
<a href="/feat-sm-content/">/feat-sm-content/</a>
|
||||
<a href="/feat-website-features/">/feat-website-features/</a>
|
||||
<a href="/feat-website-design/">/feat-website-design/</a>
|
||||
<a href="/feat-website-views/">/feat-website-views/</a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -17,8 +17,6 @@ a { color: #7ec8ff; text-decoration: none; }
|
|||
a:hover { text-decoration: underline; }
|
||||
h1 { font-size: 1.15rem; font-weight: 600; margin: 0 0 0.5rem; color: #e8eef4; }
|
||||
.meta { color: #8a96a3; margin: 0 0 1rem; }
|
||||
.nav { margin: 0.5rem 0 1rem; }
|
||||
.nav a { margin-right: 0.85rem; }
|
||||
ul.plain { padding-left: 1.2rem; margin: 0; }
|
||||
li { margin: 0.25rem 0; }
|
||||
.dim { color: #6a7682; }
|
||||
|
|
@ -26,15 +24,8 @@ li { margin: 0.25rem 0; }
|
|||
</style>
|
||||
</head>
|
||||
<body>
|
||||
{% include "_cascade/bar.html" . %}
|
||||
<h1><code>/feat-website-design/</code></h1>
|
||||
<p class="meta">last-built: 2026-09-30T02:30:50+02:00 <span class="dim">·</span> <code>feat/website-design</code> @ <code>2e26c80</code></p>
|
||||
<div class="nav">
|
||||
<a href="/">/</a>
|
||||
<a href="/main/">/main/</a>
|
||||
<a href="/feat-sm-content/">/feat-sm-content/</a>
|
||||
<a href="/feat-website-features/">/feat-website-features/</a>
|
||||
<a href="/feat-website-design/">/feat-website-design/</a>
|
||||
<a href="/feat-website-views/">/feat-website-views/</a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -17,8 +17,6 @@ a { color: #7ec8ff; text-decoration: none; }
|
|||
a:hover { text-decoration: underline; }
|
||||
h1 { font-size: 1.15rem; font-weight: 600; margin: 0 0 0.5rem; color: #e8eef4; }
|
||||
.meta { color: #8a96a3; margin: 0 0 1rem; }
|
||||
.nav { margin: 0.5rem 0 1rem; }
|
||||
.nav a { margin-right: 0.85rem; }
|
||||
ul.plain { padding-left: 1.2rem; margin: 0; }
|
||||
li { margin: 0.25rem 0; }
|
||||
.dim { color: #6a7682; }
|
||||
|
|
@ -26,15 +24,8 @@ li { margin: 0.25rem 0; }
|
|||
</style>
|
||||
</head>
|
||||
<body>
|
||||
{% include "_cascade/bar.html" . %}
|
||||
<h1><code>/feat-website-features/</code></h1>
|
||||
<p class="meta">last-built: 2026-09-30T02:30:50+02:00 <span class="dim">·</span> <code>feat/website-features</code> @ <code>53a3176</code></p>
|
||||
<div class="nav">
|
||||
<a href="/">/</a>
|
||||
<a href="/main/">/main/</a>
|
||||
<a href="/feat-sm-content/">/feat-sm-content/</a>
|
||||
<a href="/feat-website-features/">/feat-website-features/</a>
|
||||
<a href="/feat-website-design/">/feat-website-design/</a>
|
||||
<a href="/feat-website-views/">/feat-website-views/</a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -17,8 +17,6 @@ a { color: #7ec8ff; text-decoration: none; }
|
|||
a:hover { text-decoration: underline; }
|
||||
h1 { font-size: 1.15rem; font-weight: 600; margin: 0 0 0.5rem; color: #e8eef4; }
|
||||
.meta { color: #8a96a3; margin: 0 0 1rem; }
|
||||
.nav { margin: 0.5rem 0 1rem; }
|
||||
.nav a { margin-right: 0.85rem; }
|
||||
ul.plain { padding-left: 1.2rem; margin: 0; }
|
||||
li { margin: 0.25rem 0; }
|
||||
.dim { color: #6a7682; }
|
||||
|
|
@ -26,15 +24,8 @@ li { margin: 0.25rem 0; }
|
|||
</style>
|
||||
</head>
|
||||
<body>
|
||||
{% include "_cascade/bar.html" . %}
|
||||
<h1><code>/feat-website-views/</code></h1>
|
||||
<p class="meta">last-built: 2026-09-30T02:30:50+02:00 <span class="dim">·</span> <code>feat/website-views</code> @ <code>bbafc38</code></p>
|
||||
<div class="nav">
|
||||
<a href="/">/</a>
|
||||
<a href="/main/">/main/</a>
|
||||
<a href="/feat-sm-content/">/feat-sm-content/</a>
|
||||
<a href="/feat-website-features/">/feat-website-features/</a>
|
||||
<a href="/feat-website-design/">/feat-website-design/</a>
|
||||
<a href="/feat-website-views/">/feat-website-views/</a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -17,8 +17,6 @@ a { color: #7ec8ff; text-decoration: none; }
|
|||
a:hover { text-decoration: underline; }
|
||||
h1 { font-size: 1.15rem; font-weight: 600; margin: 0 0 0.5rem; color: #e8eef4; }
|
||||
.meta { color: #8a96a3; margin: 0 0 1rem; }
|
||||
.nav { margin: 0.5rem 0 1rem; }
|
||||
.nav a { margin-right: 0.85rem; }
|
||||
ul.plain { padding-left: 1.2rem; margin: 0; }
|
||||
li { margin: 0.25rem 0; }
|
||||
.dim { color: #6a7682; }
|
||||
|
|
@ -26,16 +24,9 @@ li { margin: 0.25rem 0; }
|
|||
</style>
|
||||
</head>
|
||||
<body>
|
||||
{% include "_cascade/bar.html" . %}
|
||||
<h1>cascade</h1>
|
||||
<p class="meta">last-built: 2026-09-30T02:30:50+02:00</p>
|
||||
<div class="nav">
|
||||
<a href="/">/</a>
|
||||
<a href="/main/">/main/</a>
|
||||
<a href="/feat-sm-content/">/feat-sm-content/</a>
|
||||
<a href="/feat-website-features/">/feat-website-features/</a>
|
||||
<a href="/feat-website-design/">/feat-website-design/</a>
|
||||
<a href="/feat-website-views/">/feat-website-views/</a>
|
||||
</div>
|
||||
<ul class="plain">
|
||||
<li><a href="/main/"><code>/main/</code></a> <span class="dim">·</span> <code>main</code> @ <code>d2fbd79</code></li>
|
||||
<li><a href="/feat-sm-content/"><code>/feat-sm-content/</code></a> <span class="dim">·</span> <code>feat/sm-content</code> @ <code>089ef1f</code></li>
|
||||
|
|
|
|||
|
|
@ -17,8 +17,6 @@ a { color: #7ec8ff; text-decoration: none; }
|
|||
a:hover { text-decoration: underline; }
|
||||
h1 { font-size: 1.15rem; font-weight: 600; margin: 0 0 0.5rem; color: #e8eef4; }
|
||||
.meta { color: #8a96a3; margin: 0 0 1rem; }
|
||||
.nav { margin: 0.5rem 0 1rem; }
|
||||
.nav a { margin-right: 0.85rem; }
|
||||
ul.plain { padding-left: 1.2rem; margin: 0; }
|
||||
li { margin: 0.25rem 0; }
|
||||
.dim { color: #6a7682; }
|
||||
|
|
@ -26,15 +24,8 @@ li { margin: 0.25rem 0; }
|
|||
</style>
|
||||
</head>
|
||||
<body>
|
||||
{% include "_cascade/bar.html" . %}
|
||||
<h1><code>/main/</code></h1>
|
||||
<p class="meta">last-built: 2026-09-30T02:30:50+02:00 <span class="dim">·</span> <code>main</code> @ <code>d2fbd79</code></p>
|
||||
<div class="nav">
|
||||
<a href="/">/</a>
|
||||
<a href="/main/">/main/</a>
|
||||
<a href="/feat-sm-content/">/feat-sm-content/</a>
|
||||
<a href="/feat-website-features/">/feat-website-features/</a>
|
||||
<a href="/feat-website-design/">/feat-website-design/</a>
|
||||
<a href="/feat-website-views/">/feat-website-views/</a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue