Add OpenVox 9.x docs collection as a preview (latest stays on 8.x) - #430
Open
miharp wants to merge 7 commits into
Open
Add OpenVox 9.x docs collection as a preview (latest stays on 8.x)#430miharp wants to merge 7 commits into
miharp wants to merge 7 commits into
Conversation
miharp
marked this pull request as draft
July 31, 2026 12:32
miharp
marked this pull request as ready for review
July 31, 2026 12:45
miharp
marked this pull request as draft
July 31, 2026 12:48
miharp
marked this pull request as ready for review
July 31, 2026 12:50
miharp
force-pushed
the
docs/openvox9-cutover
branch
3 times, most recently
from
August 4, 2026 10:45
21bbe65 to
cfbee43
Compare
miharp
force-pushed
the
docs/openvox9-cutover
branch
from
August 6, 2026 13:15
cfbee43 to
5af0c8e
Compare
miharp
force-pushed
the
docs/openvox9-cutover
branch
from
August 6, 2026 14:58
5c93596 to
26c371a
Compare
Contributor
|
Has the release notes generation process (including CVE fixes) been updated to handle this? |
Contributor
Author
We do not have automation for release notes, they are hand crafted for each release. |
miharp
force-pushed
the
docs/openvox9-cutover
branch
from
August 10, 2026 11:54
6432120 to
8f729ea
Compare
This was referenced Aug 10, 2026
miharp
added a commit
to miharp/openvox-docs
that referenced
this pull request
Aug 10, 2026
Point both guides at OpenVoxProject/control-repo-template instead of telling users to clone or fork puppetlabs/control-repo. The template's default branch is already production, so drop the branch-renaming caveat. Rework the crafty local guide's control-repo flow: the openvoxserver image never ran r10k on startup (the R10K_REMOTE variable in the oss compose file is unused), so deploy the code directory with the voxpupuli/r10k container before starting the server, matching crafty's own r10k example. Running r10k first also means the very first agent run reports the config_version from the deployed commit. Flow verified end-to-end against the live template with Docker. The _openvox_9x copies pick up the same change via the cutover content-drift port step (OpenVoxProject#430). Part of OpenVoxProject#444 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Michael Harp <mike@mikeharp.com>
OpenVox 9 has shipped beta packages (9.0.0-beta1) with a stable release targeted for August. Per the copy-on-major-release model in MAINTAINING.md, this stands up docs/_openvox_9x alongside the frozen 8.x collection, pinned to the 9.0.0-beta1 tag, with `latest` staying on 8.x until 9.0 is GA (Phase 2). - Copy docs/_openvox_8x -> docs/_openvox_9x and its nav file - Sweep copied content for "OpenVox 8"/"8.x" strings: bump version-generic mentions, rewrite the release notes and known issues pages for the 9.x prerelease series, and note that the supported-platforms table isn't frozen yet upstream - Register the collection in _config.yml, nav_map.yml, and navigation.yml - Add the 9x version entry to products.yml pinned to 9.0.0-beta1 - Generate references from the beta1 tag and verify the build Related to OpenVoxProject#325. Signed-off-by: Michael Harp <mike@mikeharp.com>
miharp
added a commit
to miharp/openvox-docs
that referenced
this pull request
Aug 15, 2026
Point both guides at OpenVoxProject/control-repo-template instead of telling users to clone or fork puppetlabs/control-repo. The template's default branch is already production, so drop the branch-renaming caveat. Rework the crafty local guide's control-repo flow: the openvoxserver image never ran r10k on startup (the R10K_REMOTE variable in the oss compose file is unused), so deploy the code directory with the voxpupuli/r10k container before starting the server, matching crafty's own r10k example. Running r10k first also means the very first agent run reports the config_version from the deployed commit. Flow verified end-to-end against the live template with Docker. The _openvox_9x copies pick up the same change via the cutover content-drift port step (OpenVoxProject#430). Part of OpenVoxProject#444 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Michael Harp <mike@mikeharp.com>
9.0.0-beta2 shipped 2026-08-06. Bump the products.yml reference pin so CI regenerates the 9.x reference pages from the new tag, and add a beta2 entry to the release notes with the headline breaking changes (reports default now "none", OpenFact 6.x required, hiera indirector and data-binding settings removed). Also fix custom_types.markdown's link to the pluginsync setting: the setting was removed in 9.x, so the anchor no longer exists in the regenerated configuration reference. Rewrote the step for current behavior (pluginsync is automatic). Caught by running the test:links htmlproofer config against the built 9.x tree, which the rake task's latest-only scoping doesn't cover. Co-authored-by: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Michael Harp <mike@mikeharp.com>
A sweep of the 9.0.0 prerelease changelogs against the authored pages found four behavioral claims the version-string sweep couldn't catch: - reporting_about.md said the reports setting defaults to "store"; 9.0.0-beta2 changed the default to "none" (openvox#583), making report processing opt-in. Rewrote the paragraph accordingly. - lang_relationships.markdown and services_commands_windows.markdown told readers to run `puppet agent --configprint`, which was removed along with the configprint setting in beta1 (openvox#374). Switched both to `puppet config print`. - hiera_migrate.md described data_binding_terminus as a deprecated setting; it was removed in beta2 (openvox#385). Reworded so the migration advice targets pre-upgrade cleanup. - install_pre.markdown suggested relying on the default server name `puppet`; beta1's hardening (openvox#536) removed that default for non-root and deprecated it otherwise. Now advises always setting `server` explicitly. Verified with markdownlint, a full jekyll build, and an htmlproofer pass over the built 9.x tree. Co-authored-by: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Michael Harp <mike@mikeharp.com>
PR OpenVoxProject#425 (da07ec0, "Document the remaining undocumented data types") merged after the 9.x collection was copied from 8.x, so its additions to lang_data_abstract.md, lang_data_boolean.md, and lang_data_type.md existed only in the 8.x tree — the exact content-orphaning risk binford2k raised. Applied the same diff with paths rewritten to _openvox_9x; the three pages now match their 8.x sources byte-for-byte. A sweep of every 8.x file touched since mid-July confirmed nothing else has drifted. Co-authored-by: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Michael Harp <mike@mikeharp.com>
The Phase 1 copy freezes the new collection at the moment it is made; edits merged to the old collection afterward never conflict and never surface. Add a Phase 2 step that finds the copy point, lists every old-collection change since, and ports them with a path-rewritten git apply — re-run immediately before merging the promotion PR. This bounds any docs freeze to the window between that final check and the merge. Co-authored-by: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Michael Harp <mike@mikeharp.com>
The Prerequisites section still carried the 8.x claim that we test and package with Ruby 3.2.x. The 9.x agent runtime bundles Ruby 4.0 (puppet-runtime agent-runtime-main sets ruby_version 4.0), and the openvox gem's minimum is Ruby 3.2 (openvox#442). Co-authored-by: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Michael Harp <mike@mikeharp.com>
downloads.voxpupuli.org now splits Windows and macOS installers into per-series directories (openvox8/, openvox9/). Link the 9.x install pages and the repositories page to the openvox9 subdirectories instead of the generic listing roots. Co-authored-by: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Michael Harp <mike@mikeharp.com>
miharp
force-pushed
the
docs/openvox9-cutover
branch
from
August 15, 2026 14:22
eedbcca to
00ba20c
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
OpenVox 9 has shipped beta packages (currently
9.0.0-beta2) with a stablerelease targeted for August. This stands up the
docs/_openvox_9xcollection per thecopy-on-major-release model in
MAINTAINING.md— Phase 1 of the two-phasecutover: the new version is browsable at
/openvox/9.x/, while/openvox/latest/keeps serving OpenVox 8 until 9.0 goes GA (Phase 2, a separate follow-up PR).
docs/_openvox_8x→docs/_openvox_9xand its nav file(not a blind find/replace — see
MAINTAINING.md's content-sweep step):release_notes.markdownfor the 9.x prerelease series(
9.0.0-alpha1/alpha2/beta1/beta2) instead of carrying over 8.x'srelease history
known_issues.md(the one listed issue was specific to8.26.2)supported_platforms.md:shared-actions/platforms.jsonhasn't frozen adedicated
9.xkey yet, so the 9.x table sources frommainwith a notethat it isn't final
against the
9.0.0-beta2source: the v3/v4 config parsing inlib/puppet/pops/lookup/hiera_config.rbis still present; beta2's hieraremovals are the deprecated
hieraindirector and the data-bindingsettings, not the file-format support)
_config.yml,_data/nav_map.yml, and_data/navigation.yml9xversion entry to_data/products.yml, pinned to9.0.0-beta2jekyll build+rake test:links, plus an htmlproofer pass over the built9.x tree (which
test:linksdoesn't cover — it only proofslatesttrees).That pass caught one stale link:
custom_types.markdownpointed at thepluginsyncsetting, which was removed in 9.x; rewrote that step forcurrent behavior
pages for behavioral claims that a version-string sweep can't catch. Four
pages needed fixes: the
reportsdefault is nownone(openvox#583), thepuppet agent --configprintcommand was removed along with theconfigprintsetting (openvox#374; now
puppet config print),data_binding_terminuswas removed rather than deprecated (openvox#385), and agents no longer fall
back to the default server hostname
puppet(openvox#536)was made) into the 9.x collection, so the two trees are content-synced as of
this writing, and added a Phase 2 runbook step to
MAINTAINING.mdthatre-checks for and ports 8.x drift before the GA promotion — this bounds any
docs freeze to the window between that final check and the promotion merge
Related to #325.
Pages with content changes vs 8.x
Everything else in
docs/_openvox_9xis either an unmodified copy of the 8.xauthored page or a freshly generated reference page. These are the only pages with
hand-edited content, per the sweep above:
index.mdrelease_notes.markdownknown_issues.mdsupported_platforms.mdplatforms.json'smainkey, since it hasn't frozen a9.xkey yetupgrade_minor.mdinstall_pre.markdownserverexplicitly, since 9.x removed the defaultpuppethostname fallback (openvox#536)hiera_config_yaml_3.mdhiera_config_yaml_4.mdhiera_migrate.mddata_binding_terminusguidance reworded as pre-upgrade cleanup, since the setting was removed in 9.x (openvox#385)custom_types.markdownpluginsyncsetting (removed in 9.x, so the anchor no longer exists) and rewrote the step for current behaviorreporting_about.mdreportsdefault changed fromstoretononein 9.x (openvox#583), so report processing is opt-inlang_relationships.markdownpuppet agent --configprint graphdir→puppet config print graphdir(option removed with theconfigprintsetting, openvox#374)services_commands_windows.markdownpuppet agent --configprint SETTING→puppet config print SETTING(same removal)_data/nav/openvox_9x.ymlActual content diffs (8.x → 9.x) — GitHub's per-PR file view shows these paths as 100% new since they didn't exist on
master; these are realdiff -uoutput against the corresponding 8.x source. (release_notes.markdownisn't included here — it's a full rewrite, not a targeted edit; see its diff link in the table above.)index.mdknown_issues.mdsupported_platforms.mdupgrade_minor.mdinstall_pre.markdownhiera_config_yaml_3.mdhiera_config_yaml_4.mdhiera_migrate.mdcustom_types.markdownreporting_about.mdlang_relationships.markdownservices_commands_windows.markdownScreenshots
Local
jekyll serverender of the pages with content changes:index.md(screenshot:

openvox9-index.png)release_notes.markdown(screenshot:

openvox9-release-notes.png)supported_platforms.md(screenshot:

openvox9-supported-platforms.png)upgrade_minor.md(screenshot:

openvox9-upgrade-minor.png)Test plan
bundle exec rake references:openvox VERSION=9.0.0-beta2 COLLECTION=_openvox_9x INSTALLPATH=docsbundle exec jekyll build— confirmed/openvox/8.x/,/openvox/9.x/, and/openvox/latest/all render, withlateststill serving OpenVox 8bundle exec rake test:links— passes (this task only proofslatesttrees, so it doesn't cover 9.x yet — a known, already-tracked gap)
test:links) over the built_site/openvox/9.xtree — passes after thecustom_types.markdownpluginsyncfixsupported platforms, upgrade guide) via local
jekyll serve— seescreenshots above
Reviewer: sanity-check the hiera v3/v4 backward-compat wording called— verified against theout above
9.0.0-beta2source (see the sweepnote above)