Repository navigation
Commit 1fa33a6
authored
build(docs): generate reference pages for Valkey, OpenSearch, Bucket, KubernetesNodes, ComputePlane and Gateway (#756)
Cozystack 1.7 adds Valkey and the ComputePlane module and moves worker
pools to KubernetesNodes, while OpenSearch, Bucket and the tenant
Gateway module never had a reference page. Their READMEs are generated
by cozyvalues-gen and match `values.yaml` at v1.7.0-rc.1, but none of
them is in the Makefile lists, so 1.7 docs would ship without them.
- `valkey`, `opensearch` and `bucket` go to `APPS` (`applications/`)
- `kubernetes-nodes` gets its own list and renders as
`kubernetes/kubernetes-nodes.md` in the Kubernetes section
- `computeplane` and `gateway` go to `SERVICES` on a separate `SERVICES
+=` line, because the `SERVICES` line is next to `NETWORKING` and
editing both would conflict
Each app gets a front matter template in `next/`. `release-next` copies
templates into `v1.7/` and the promote run renders pages from the
release ref, so no generated page is committed here.
Patch releases of older lines run the same lists against their own tag.
Valkey and ComputePlane have no README at v1.6 and v1.5, so
`update_apps.sh` would exit 1 on 404 and fail the docs job. For
OpenSearch, Bucket, Gateway and KubernetesNodes the old `touch` fallback
would write an empty template and a page without front matter into the
old tree. Now `update_apps.sh` treats the `_include/<app>.md` template
as the list of apps a version documents: app without template is skipped
with a warning before anything is fetched or written, app with template
but missing README still fails as before. This covers what #728 does
with its trunk-only list. I didn't reuse that list because the promote
run skips it, `release-next` registers the new version before
`update-all` routes to it.
Bucket and Gateway pages overlap with hand-written
`object-storage/buckets.md` and `networking/gateway-api.md`. I wired
them anyway, say if you want them out. The KubernetesNodes commit is
separate and easy to drop.
Checks: I replayed promote on a copy (`release-next`, then `update-all
RELEASE_TAG=v1.7.0 FETCH_REF=v1.7.0-rc.1`), all six pages generate into
`v1.7/` and Hugo 0.164.0 preview and production builds pass.
`update-all` for v1.6.5 and v1.5.5 passes with six skip warnings and
adds no files, with main's script the v1.6 run fails on valkey 404. With
http-cache still listed the v1.7.0 run still fails on its 404, so the
guard doesn't hide a removed app. shellcheck reports nothing new and
i18n checks pass.
Both this PR and the HTTPCache one must land before the v1.7.0 promote
run. They merge cleanly in any order, #728 can go after the 1.7
snapshot.8 files changed
Lines changed: 53 additions & 5 deletions
File tree
- content/en/docs/next
- applications/_include
- kubernetes/_include
- operations/services/_include
- hack
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
72 | 72 | | |
73 | 73 | | |
74 | 74 | | |
75 | | - | |
| 75 | + | |
76 | 76 | | |
| 77 | + | |
77 | 78 | | |
78 | 79 | | |
79 | 80 | | |
| 81 | + | |
80 | 82 | | |
81 | 83 | | |
| 84 | + | |
82 | 85 | | |
83 | 86 | | |
84 | 87 | | |
| |||
99 | 102 | | |
100 | 103 | | |
101 | 104 | | |
| 105 | + | |
102 | 106 | | |
103 | 107 | | |
104 | 108 | | |
| |||
186 | 190 | | |
187 | 191 | | |
188 | 192 | | |
| 193 | + | |
189 | 194 | | |
190 | 195 | | |
191 | 196 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
| 22 | + | |
| 23 | + | |
22 | 24 | | |
23 | 25 | | |
24 | 26 | | |
| |||
84 | 86 | | |
85 | 87 | | |
86 | 88 | | |
87 | | - | |
| 89 | + | |
88 | 90 | | |
89 | 91 | | |
90 | 92 | | |
| |||
101 | 103 | | |
102 | 104 | | |
103 | 105 | | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
104 | 115 | | |
105 | 116 | | |
106 | 117 | | |
| |||
119 | 130 | | |
120 | 131 | | |
121 | 132 | | |
122 | | - | |
123 | | - | |
124 | | - | |
125 | 133 | | |
126 | 134 | | |
127 | 135 | | |
| |||
0 commit comments