Skip to content

Update the stale OpenBolt pages left out of the #537 work - #551

Merged
miharp merged 2 commits into
OpenVoxProject:masterfrom
miharp:docs/openbolt-stale-pages-537
Oct 28, 2026
Merged

miharp merged 2 commits into
OpenVoxProject:masterfrom
miharp:docs/openbolt-stale-pages-537

Conversation

@miharp

@miharp miharp commented Oct 27, 2026

Copy link
Copy Markdown
Contributor

PR 3 of #548: the pages #537 left as they were.

Changes

  • developer_updates.md was Puppet's 2020-2021 dev blog. openbolt main (unreleased 9.x) prints
    https://docs.openvoxproject.org/openbolt/latest/developer_updates.html#deprecating-dotted-fact-names
    in its dotted fact name warning, so the page isn't deleted. It becomes a short "Dotted fact
    names" page at the same URL, with its H1 pinned to that anchor, and leaves the nav. The old
    section said Facter 4 turns dotted names into structured facts. OpenFact only does that when
    force-dot-resolution is true, so the page now says that and recommends structured facts.
  • experimental_features.md stays. OpenBolt 5.6.0 still marks every feature on it experimental
    (warnings in lib/bolt, doc comments in bolt-modules), and openbolt's source and the
    generated transports reference link to its #native-ssh-transport and
    #resourceinstance-data-type anchors. The CONTRIBUTING.md naming rule is applied (prose only,
    with a/an fixed), the eight "introduced in Bolt x.y" paragraphs that linked Puppet's CHANGELOG
    are gone, and the intro about "the Bolt team" is rewritten.
  • inventory_files.md said version 1 inventory files are deprecated. OpenBolt rejects them with
    an error, and the page now says so.
  • modules.md and projects.md: drop the Bolt 2.23 and 2.30 references and the link to the
    developer update. The modules.md section heading changes; nothing links to its anchor.
  • bolt_installing_modules.md: pin {#manually-specify-modules-in-a-bolt-project}. openbolt
    main links to that anchor, and Rename Bolt to OpenBolt across the OpenBolt 5 docs #544 renamed the heading.

Verification

  • On OpenBolt 5.6.0 from the openvox8 apt repo: the dotted fact warning with
    [ID: dotted_fact_name]; disable-warnings: [dotted_fact_name] silencing it; OpenBolt keeping
    role.name flat; the structured inventory example producing no warning; a version 1 inventory
    (nodes:) failing with "no longer supported"; and bolt project migrate converting it to
    targets:.
  • OpenFact 6.2.1: a custom fact app.tier and an external fact role.name stay flat keys in
    facter -j.
  • All 15 docs URLs that openbolt main links to resolve in a local build, anchors included. One
    was missing before this PR.
  • markdownlint-cli2, jekyll build with references generated, and rake test:links pass.

Part of #548

Assisted by Claude.

OpenVoxProject#537 left developer_updates.md, experimental_features.md, and the
"introduced in Bolt 2.x" callouts as they were. Several of them turned
out to be wrong, not just old.

- developer_updates.md was Puppet's 2020-2021 dev blog, but openbolt
  main prints a link to its #deprecating-dotted-fact-names section in a
  runtime warning. Cut it down to a "Dotted fact names" page at the same
  URL and anchor, out of the nav. The old section said Facter 4 turns
  dotted names into structured facts; OpenFact only does that with
  force-dot-resolution set, so the page now says so.
- experimental_features.md stays because OpenBolt 5.6.0 still marks all
  of its features experimental and openbolt's generated references link
  to its anchors. Apply the OpenBolt naming rule, drop the eight
  "introduced in Bolt x.y" paragraphs, and rewrite the intro about the
  Bolt team.
- inventory_files.md called version 1 inventory files deprecated.
  OpenBolt rejects them with an error.
- modules.md and projects.md: drop the Bolt 2.23/2.30 references and the
  link to the developer update.
- bolt_installing_modules.md: pin the
  #manually-specify-modules-in-a-bolt-project anchor, which openbolt main
  links to and OpenVoxProject#544 renamed.

Checked on packaged OpenBolt 5.6.0: the dotted fact warning, its
disable-warnings ID, structured inventory facts, a version 1 inventory
error, and `bolt project migrate` converting it. OpenFact 6.2.1 keeps
dotted custom and external fact names flat by default. All 15 URLs that
openbolt main links to resolve in a local build with references
generated; markdownlint and the internal link check pass.

Part of OpenVoxProject#548

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Michael Harp <mike@mikeharp.com>
@miharp
miharp requested a review from a team as a code owner October 27, 2026 14:02
@miharp miharp mentioned this pull request Oct 27, 2026
4 tasks done
Comment thread docs/_openbolt_5x/experimental_features.md Outdated
Comment thread docs/_openbolt_5x/experimental_features.md
Review feedback on OpenVoxProject#551:

- With the "introduced in Bolt 3.21.0" line gone, the policies section
  went straight from its heading into a "What are policies?" subheading.
  Drop the subheading so its paragraph introduces the section. Nothing
  in the docs or in openbolt links to its anchor.
- Rename Bolt to OpenBolt in a comment in the background() example. The
  earlier sweep skipped code blocks; the other "Bolt" mentions in code
  blocks in this PR's files are literal OpenBolt output or sample
  passwords.

Part of OpenVoxProject#548

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Michael Harp <mike@mikeharp.com>
@miharp
miharp merged commit d9c049a into OpenVoxProject:master Oct 28, 2026
5 checks passed
@miharp
miharp deleted the docs/openbolt-stale-pages-537 branch October 28, 2026 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants