Skip to content

docs/_openvoxdb_8x: Clean up and modernize collection #206

@miharp

Description

@miharp

The _openvoxdb_8x collection was ported from PuppetDB docs and needs a systematic
cleanup pass. 95 files, ~1,933 instances of upstream branding to update, plus structural
and content issues found in a thorough audit.

1. Rebrand (highest priority — pervasive) ✅ Done in #207

  • Replace PuppetDB / puppetdbOpenVoxDB / openvoxdb across all 95 files
  • Update GitHub links from github.com/puppetlabs/puppetdbgithub.com/OpenVoxProject/openvoxdb
  • Update Forge module URLs → https://forge.puppet.com/modules/puppet/openvoxdb
  • Audit Puppet®, Puppet Labs references — removed "generated by Puppet®", "Puppet Labs® issue tracker", "Puppet Labs Status API" framing
  • Update CONTRIBUTING.md — Jira tracker link replaced with GitHub issues
  • Replace remaining "PuppetDB" references in _data/nav/openvoxdb_8x.yml

Intentionally deferred from rebrand scope:

  • Review PE-only feature markers (ha.markdown and others marked "PE-only") — clarify which features are available in open-source OpenVoxDB
  • Update puppet.com/docs/puppet/latest/ external links → /openvox/latest/ equivalents (see comment below for full audit)

2. Structural fixes (quick wins)

  • Remove duplicate: index.md and overview.markdown have identical content — remove one, keep the other
  • Add missing YAML frontmatter to acceptance_tests.markdown (currently has none)
  • Add missing YAML frontmatter to configure_postgres.markdown (currently has none)
  • Audit ~62 pages not linked from _data/nav/openvoxdb_8x.yml — add them, or decide to intentionally omit them:
    • Operational: logging.html, load_testing_tool.html, repl.html, testing_storage_changes.html, trouble_session_logging.html, migration_coordination.html, acceptance_tests.html
    • All API v4 query endpoint detail pages
    • Wire format versions v6–v8 (catalog), v4 (facts), v5–v7 (reports)
    • PQL/AST docs, tutorials, curl tips

3. Content accuracy

  • Fix placeholder/corrupted text: xxxxxz string in release_notes_6.markdown
  • Fix "Puppet DB" (with space) → "OpenVoxDB" in release_notes_6.3.markdown
  • Update PostgreSQL version support table — clarify what OpenVoxDB 8.x actually supports vs legacy versions
  • Remove or update "Experimental" label on PQL in api/query/v4/pql.markdown (PQL is stable)
  • Review deprecated Metrics API docs (api/metrics/v2/jolokia.markdown) — update or add deprecation notice
  • Fix outdated external links:
    • PostgreSQL docs URLs using old /static/ path format
    • puppet.com/docs/puppetdb/latest/configure.html#vardir in maintain_and_tune.markdown → internal link
    • Note: tickets.puppetlabs.com Jira links and forge.puppetlabs.com URLs were fixed in rebrand openvoxdb_8x: PuppetDB -> OpenVoxDB throughout #207

4. Release notes cleanup

  • Resolve overlap between release_notes.markdown and release_notes_8.markdown (appear to cover same 8.x content)
  • Decide whether to archive release_notes_older.markdown (191KB, covers PDB 1–5 history) — keeping for now per project decision

Notes

  • Old release notes for PuppetDB 1–7 (release_notes_older.markdown, release_notes_5.2.markdown, etc.) are intentionally left as historical record — no changes needed there
  • Technical names kept as-is (verified against https://github.com/voxpupuli/puppet-openvoxdb): service name puppetdb, system paths /etc/puppetlabs/puppetdb/, database name puppetdb, [puppetdb] INI section, storeconfigs_backend = puppetdb, reports = store,puppetdb, puppetdb.conf filename

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions