Add OpenFact 6.x docs collection as a preview (latest stays on 5.x) - #459
Open
miharp wants to merge 1 commit into
Open
Add OpenFact 6.x docs collection as a preview (latest stays on 5.x)#459miharp wants to merge 1 commit into
miharp wants to merge 1 commit into
Conversation
miharp
force-pushed
the
docs/openfact6-cutover
branch
from
August 27, 2026 13:37
df83044 to
42cbfa8
Compare
miharp
added a commit
to miharp/openvox-docs
that referenced
this pull request
Aug 27, 2026
Add an upgrade-planning page to the 9.x collection covering what to review before moving a production deployment from OpenVox 8 to 9, alongside the existing package-mechanics page (upgrade_minor): - Component version table: Ruby 3.2 -> 4.0, OpenSSL 3.0 -> 3.5, OpenFact 5.x -> 6.x, JRuby 9.4 -> 10.1, Java 21/25 (17 dropped) - Ruby 4.0 review guidance for custom facts, functions, types, providers, and agent/server-installed gems - Behavior changes verified against the 9.0.0 prerelease sources: deferred functions preprocessed by default again (openvox#462), reports default store -> none (openvox#583), and the server setting fallback deprecation (openvox#536 - root agents still fall back with a warning, non-root runs fail; the code keeps the root fallback in beta2, so the page documents the deprecation rather than a hard removal) - Removed settings (configprint, pluginsync, data_binding_terminus, environment_data_provider) and other removals (regsubst encoding argument, pe_serverversion fact, zone_core module, Java keystores, legacy PAL APIs) - Server/OpenVoxDB notes: Java 17 dropped, Jetty 12, OpenVoxDB Debian 11/12 packages discontinued, openvox-server 9 requires openvox-agent 9 on the same host - Test-then-upgrade checklist and upgrade order Also add the nav entry and cross-link the page from the breaking- changes callout in upgrade_minor. Updated after the server, OpenVoxDB, and OpenFact 6 preview cutovers (OpenVoxProject#457, OpenVoxProject#458, OpenVoxProject#459): per-component release-notes links, OpenVox Server 9 also dropping Debian 11/12 and Amazon Linux 2, the OpenVox Server 9 filebucket read-authorization change (openvox-server#549), the OpenVoxDB bootstrap.cfg jetty10-service pitfall for upgrades from 8.14.0 or earlier, the PostgreSQL 14 minimum, and the concrete OpenFact 6 changes that affect fact code. Part of OpenVoxProject#456 Co-authored-by: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Michael Harp <mike@mikeharp.com>
Phase 1 of the major-version cutover in MAINTAINING.md for OpenFact: copy docs/_openfact_5x to docs/_openfact_6x, register the collection, nav map, product bar entry, and products.yml version pinned to the 6.0.0 tag, and leave `latest` on 5.x, which is the series bundled with the stable 8.x agent. OpenFact 6 is bundled with openvox-agent 9.x, so `latest` moves with the OpenVox 9 promotion. The generated pages (core_facts, cli) are gitignored and CI regenerates them from the pin; a local `rake references:openfact VERSION=6.0.0 COLLECTION=_openfact_6x INSTALLPATH=docs` run succeeds and the output differs from 5.6.1 only in build metadata and the localized canonical. Authored content updated for 6.0.0: - index: title, which agent series bundles OpenFact 6, Ruby 3.0+ requirement, component-versions link to the 9.x page - custom_facts: the /opt/puppetlabs/bin search-path addition (openfact#138), the time_limit/limit alias deprecation (OpenVoxProject#114), and the exec/which runtime deprecation warnings (OpenVoxProject#121) - release_notes: rewritten for the 6 series Part of OpenVoxProject#456 Co-authored-by: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Michael Harp <mike@mikeharp.com>
miharp
force-pushed
the
docs/openfact6-cutover
branch
from
August 27, 2026 21:53
42cbfa8 to
95ec14c
Compare
miharp
added a commit
to miharp/openvox-docs
that referenced
this pull request
Aug 27, 2026
Add an upgrade-planning page to the 9.x collection covering what to review before moving a production deployment from OpenVox 8 to 9, alongside the existing package-mechanics page (upgrade_minor): - Component version table: Ruby 3.2 -> 4.0, OpenSSL 3.0 -> 3.5, OpenFact 5.x -> 6.x, JRuby 9.4 -> 10.1, Java 21/25 (17 dropped) - Ruby 4.0 review guidance for custom facts, functions, types, providers, and agent/server-installed gems - Behavior changes verified against the 9.0.0 prerelease sources: deferred functions preprocessed by default again (openvox#462), reports default store -> none (openvox#583), and the server setting fallback deprecation (openvox#536 - root agents still fall back with a warning, non-root runs fail; the code keeps the root fallback in beta2, so the page documents the deprecation rather than a hard removal) - Removed settings (configprint, pluginsync, data_binding_terminus, environment_data_provider) and other removals (regsubst encoding argument, pe_serverversion fact, zone_core module, Java keystores, legacy PAL APIs) - Server/OpenVoxDB notes: Java 17 dropped, Jetty 12, OpenVoxDB Debian 11/12 packages discontinued, openvox-server 9 requires openvox-agent 9 on the same host - Test-then-upgrade checklist and upgrade order Also add the nav entry and cross-link the page from the breaking- changes callout in upgrade_minor. Updated after the server, OpenVoxDB, and OpenFact 6 preview cutovers (OpenVoxProject#457, OpenVoxProject#458, OpenVoxProject#459): per-component release-notes links, OpenVox Server 9 also dropping Debian 11/12 and Amazon Linux 2, the OpenVox Server 9 filebucket read-authorization change (openvox-server#549), the OpenVoxDB bootstrap.cfg jetty10-service pitfall for upgrades from 8.14.0 or earlier, the PostgreSQL 14 minimum, and the concrete OpenFact 6 changes that affect fact code. Part of OpenVoxProject#456 Co-authored-by: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Michael Harp <mike@mikeharp.com>
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.
Phase 1 of the major-version cutover in
MAINTAINING.mdfor OpenFact, following #430 (core), #457 (server), and #458 (OpenVoxDB):docs/_openfact_5xcopied todocs/_openfact_6x, the collection registered in_config.yml,nav_map.yml,navigation.yml, andproducts.ymlwith a6.0.0reference pin.lateststays on 5.x.OpenFact 6.0.0 is already GA (2026-07-31), so this could have been a Phase 1+2 promotion. I kept
lateston 5.x deliberately: 5.x is what the stableopenvox-agent8.x bundles (5.6.1 in 8.28.x per the component-versions data), and OpenFact 6 ships only with the 9.x agent. Movinglatesthere would put 6.x docs in front of readers of the stable agent docs. It moves with the OpenVox 9 promotion instead. Happy to flip it in this PR if you would rather track the OpenFact release itself.Part of #456.
What changed beyond the copy
index.mdcustom_facts.md/opt/puppetlabs/binsearch-path addition (openfact#138); note thattime_limit/limitare deprecated aliases oftimeout(#114); theexec/whichdeprecation note extended to the 6.0 runtime warnings (#121)release_notes.md_data/products.yml6xversion pinned toref: "6.0.0";lateststays5xGenerated pages
core_facts.mdandcli.mdare gitignored in the collection and CI regenerates them from the pin at build time, as for the other generated collections. A localbundle exec rake references:openfact VERSION=6.0.0 COLLECTION=_openfact_6x INSTALLPATH=docsrun succeeds (about 11 seconds), and the output differs from the 5.6.1 pages only inbuilt_from_commit, the generation-date note, and thecanonicalfront matter, which correctly localizes to/openfact/6.x/. The 6.0.0 man-page.Elfix does not change the rendered CLI page.How the content was checked
OpenFact 5,5.x): the only hit was the index title.ldapnameremoved (Work on openvox auto generate preamble #111, not documented anywhere so nothing to change),time_limit/limitalias deprecation (Remove content which gets autogenerated #114),exec/whichruntime warnings (Fix or remove legacy /puppet/ and /pe/ internal links #121),Resolvable#limitdeprecation (Fix unresolved Liquid template variables producing broken links in openvox_8x collection #115), and the/opt/puppetlabs/binsearch-path addition (Fix typos and whitespace #138, list taken fromDEFAULT_SEARCH_PATHSin the PR diff).configuring_openfact.mdandfact_overview.mdneeded no changes.jekyll build,rake test:products_data, markdownlint on the authored pages, and htmlproofer over_site/openfact/6.x: the only failures are the openbolt OpenBolt generated reference pages return 404 #202 pages thattest:linksalready ignores.Screenshots
Diffs for the small edits
diff against the 5.x source
+> Note: The
time_limitandlimitoption keys are compatibility aliases fortimeout.+> Starting in OpenFact 6.0 they emit a deprecation warning; use
timeout.+
-> Please note that Facter::Core::Execution::exec has been deprecated in favor of Facter::Core::Execution::execute. This is important when migrating from older versions of Facter.
+> Please note that
Facter::Core::Execution.exechas been deprecated in favor ofFacter::Core::Execution.execute, as haveFacter::Util::Resolution.execandFacter::Util::Resolution.which. Starting in OpenFact 6.0 these methods emit a runtime deprecation warning and will be removed in a future major release. This is important when migrating from older versions of Facter.Logging