Skip to content

Commit 5bae727

Browse files
miharpclaude
andcommitted
Runbook: sweep the nav file too during the version-string review
An end-to-end sandbox cutover surfaced that the content sweep missed the copied nav data file (_data/nav/openvox_9x.yml): its section headings ('OpenVox 8 Platform') and link text ('Upgrading OpenVox 8') are authored version strings, but the git grep only covered docs/_openvox_9x. Copy + stage the nav file in step 1 and include it in the sweep pathspec so those get reviewed too. Part of #325. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Michael Harp <mike@mikeharp.com>
1 parent f0abdd2 commit 5bae727

1 file changed

Lines changed: 23 additions & 19 deletions

File tree

MAINTAINING.md

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -42,26 +42,31 @@ as needed.
4242
Do this when the new major has a tag to build against (a prerelease/RC is fine), but
4343
is **not yet** the stable release. `latest` stays on the current major.
4444

45-
1. **Copy the collection, and stage it** so the sweep in step 2 sees only authored
46-
pages:
45+
1. **Copy the collection and its nav file, and stage them** so the sweep in step 2
46+
sees all the authored content:
4747

4848
```console
4949
cp -r docs/_openvox_8x docs/_openvox_9x
50-
git add docs/_openvox_9x
50+
cp _data/nav/openvox_8x.yml _data/nav/openvox_9x.yml
51+
git add docs/_openvox_9x _data/nav/openvox_9x.yml
5152
```
5253

5354
Generated reference pages are gitignored within the collection, so `git add`
5455
stages only the authored content — and `git grep` below then skips the generated
5556
pages automatically (they self-update from the new tag at build time).
5657

57-
2. **Sweep the copied authored pages for version-specific strings** and review each
58-
in context (titles, nav headings, prose, compatibility notes, "upgrading from N"
59-
pages). Target the **major you're leaving behind** (here, `8`):
58+
2. **Sweep the copied authored content for version-specific strings** and review each
59+
in context (page titles, prose, compatibility notes, "upgrading from N" pages, and
60+
the **nav file's** section headings and link text). Target the **major you're
61+
leaving behind** (here, `8`):
6062

6163
```console
62-
git grep -nE 'OpenVox 8|8\.x' -- docs/_openvox_9x
64+
git grep -nE 'OpenVox 8|8\.x' -- docs/_openvox_9x _data/nav/openvox_9x.yml
6365
```
6466

67+
Don't forget the nav file — its headings (e.g. "OpenVox 8 Platform") and link
68+
text ("Upgrading OpenVox 8") are authored strings that won't update on their own.
69+
6570
This is a review, **not** a blind find/replace. The hits fall into two kinds:
6671
straightforward current-version labels (page titles, "OpenVox 8 uses…") that bump
6772
to the new major, and version-*specific* content (e.g. "8.x still supports hiera 4
@@ -86,19 +91,18 @@ is **not yet** the stable release. `latest` stays on the current major.
8691
nav: openvox_9x
8792
```
8893
89-
4. **Wire up navigation:**
90-
- Create `_data/nav/openvox_9x.yml` (copy from `openvox_8x.yml`; adjust as the
91-
9.x structure diverges). Nav links are relative, so they resolve under
92-
`/openvox/9.x/...` automatically — no rewriting needed.
93-
- Add a **new** entry to `_data/nav_map.yml` whose `nav_key` matches the `nav:`
94-
default from step 3 (do *not* add the collection to the existing 8.x entry —
95-
`nav: openvox_9x` only resolves against a `nav_key: openvox_9x`):
94+
4. **Wire up navigation.** The nav file (`_data/nav/openvox_9x.yml`) was already
95+
copied and swept in steps 1–2; adjust it further as the 9.x structure diverges
96+
(its links are relative, so they resolve under `/openvox/9.x/...` automatically).
97+
Then add a **new** entry to `_data/nav_map.yml` whose `nav_key` matches the `nav:`
98+
default from step 3 (do *not* add the collection to the existing 8.x entry —
99+
`nav: openvox_9x` only resolves against a `nav_key: openvox_9x`):
96100

97-
```yaml
98-
- nav_key: openvox_9x
99-
collections: openvox_9x
100-
base: /openvox/9.x/
101-
```
101+
```yaml
102+
- nav_key: openvox_9x
103+
collections: openvox_9x
104+
base: /openvox/9.x/
105+
```
102106

103107
5. **Add the version to `_data/products.yml`** (newest first), keeping `latest: 8x`
104108
for now:

0 commit comments

Comments
 (0)