Skip to content

Restore environment documentation from Puppet 5.4 archive#79

Merged
tuxmea merged 1 commit intoOpenVoxProject:masterfrom
miharp:fix/environments-docs
Apr 23, 2026
Merged

Restore environment documentation from Puppet 5.4 archive#79
tuxmea merged 1 commit intoOpenVoxProject:masterfrom
miharp:fix/environments-docs

Conversation

@miharp
Copy link
Copy Markdown
Contributor

@miharp miharp commented Apr 23, 2026

Scope

Restores three stub environment pages under docs/_openvox_8x/ with full content from the
puppetlabs/docs-archive (puppet/5.4).

Changes

  • environments_about.markdown: Restored concepts, main use cases (permanent/temporary test
    environments, divided infrastructure), limitations (plugin leakage, exported resource conflicts),
    and troubleshooting guidance
  • environments_creating.markdown: Restored environment structure, resources (modulepath, main
    manifest, Hiera data, config version script, environment.conf), creation steps, node assignment via
    ENC and config file, and global puppet.conf settings
  • environment_isolation.md: Restored generate types command usage, r10k integration, and
    troubleshooting steps

Adaptations from the archive source:

  • Puppet master/server references → OpenVox server
  • Prose "Puppet" → "OpenVox" where referring to the product
  • Removed Kramdown class tags ({:.concept}, {:.task}, {:.reference}) not used in this theme
  • Removed Puppet Enterprise-specific content and PE-only links
  • Removed unused link reference definitions (MD053)
  • Added language specifiers to fenced code blocks (MD040)
  • Aligned table columns (MD060)

Test plan

  • bundle exec jekyll build succeeds with no errors
  • markdownlint-cli2 reports 0 errors against the project's planned 210-char line-length config
    (see #30)

🤖 Generated with Claude Code

Replace three stub pages with full content restored from
puppetlabs/docs-archive (puppet/5.4):

- environments_about.markdown: concepts, use cases, and limitations
- environments_creating.markdown: structure, resources, creation steps,
  node assignment, and global puppet.conf settings
- environment_isolation.md: generate types command, r10k integration,
  and troubleshooting

Updates throughout: Puppet master/master -> OpenVox server, prose
Puppet -> OpenVox where referring to the product. Removes Kramdown
class tags ({:.concept} etc.) and PE-specific content. Unused link
reference definitions removed (MD053). Code blocks annotated with
language (MD040).

Signed-off-by: Michael Harp <mike@mikeharp.com>
@miharp miharp marked this pull request as ready for review April 23, 2026 13:13
@miharp miharp requested a review from a team as a code owner April 23, 2026 13:13
@tuxmea tuxmea merged commit f0b6377 into OpenVoxProject:master Apr 23, 2026
2 checks passed
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