Skip to content

Fix broken links and update community resources in bgtm.md#67

Open
miharp wants to merge 2 commits intoOpenVoxProject:masterfrom
miharp:fix/bgtm-links-and-cleanup
Open

Fix broken links and update community resources in bgtm.md#67
miharp wants to merge 2 commits intoOpenVoxProject:masterfrom
miharp:fix/bgtm-links-and-cleanup

Conversation

@miharp
Copy link
Copy Markdown
Contributor

@miharp miharp commented Apr 19, 2026

Summary

  • Fix all http://https:// for Forge, rspec-puppet, Vagrant, and Serverspec URLs
  • Fix section TOC anchors to match actual heading IDs
  • Change code fences from ruby to puppet for Puppet code examples; add ruby hint to RSpec/Rakefile examples
  • Fix extra backtick on closing rspec code fence
  • Fix containment code block indentation
  • Remove Puppet 3.4 anchor pattern paragraph (not relevant for OpenVox 8)
  • Fix missing space in documenting section prose
  • Add note that the open source PDK is no longer actively supported
  • Update community resources: replace individual Puppet Slack/IRC links with Vox Pupuli community channels
  • Remove all {:.concept}/{:.section} kramdown markers unused by the current theme

Test plan

  • bundle exec jekyll build completes without errors
  • Page renders correctly at /openvox/8.x/bgtm.html
  • All internal links resolve

🤖 Generated with Claude Code

@miharp miharp force-pushed the fix/bgtm-links-and-cleanup branch 4 times, most recently from 410041b to c78f318 Compare April 19, 2026 16:48
Comment thread docs/_openvox_8x/bgtm.md
The [puppet-users mailing list](https://groups.google.com/forum/#!forum/puppet-users)
[The Forge](https://forge.puppet.com)

`#puppet` on IRC
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I recommend to just point to https://voxpupuli.org/connect/ . That has a list of all the various channels and protocols and is our authoritative source.

@miharp miharp force-pushed the fix/bgtm-links-and-cleanup branch 2 times, most recently from 0f05da2 to 3e56ae0 Compare April 20, 2026 10:30
- Fix all http:// → https:// for Forge, rspec-puppet, Vagrant, and Serverspec URLs
- Fix section TOC anchors to match actual heading IDs
- Change code fences from 'ruby' to 'puppet' for Puppet code examples; add 'ruby' hint to RSpec/Rakefile examples
- Fix extra backtick on closing rspec code fence
- Fix containment code block indentation
- Remove Puppet 3.4 anchor pattern paragraph (not relevant for OpenVox 8)
- Fix missing space in documenting section prose
- Update community resources: replace Puppet Slack/IRC with Vox Pupuli Slack and #voxpupuli on Libera.Chat
- Remove all {:.concept}/{:.section} kramdown markers unused by theme

Signed-off-by: Michael Harp <mike@mikeharp.com>
@miharp miharp force-pushed the fix/bgtm-links-and-cleanup branch from 3e56ae0 to 9cc94d7 Compare April 20, 2026 10:38
@miharp miharp marked this pull request as ready for review April 20, 2026 10:39
@miharp miharp requested a review from a team as a code owner April 20, 2026 10:39
Copy link
Copy Markdown
Contributor

@cvquesty cvquesty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Comment thread docs/_openvox_8x/bgtm.md Outdated
````
```

RSpec lets you provide facts, like `osfamily`, in order to test the module in various scenarios.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please switch to new structured facts os['family']

Comment thread docs/_openvox_8x/bgtm.md Outdated
A typical use of RSpec is to iterate over a list of operating systems, asserting that the package and service should exist in the catalog for every operating system your module supports.

To learn more, see [http://rspec-puppet.com/](http://rspec-puppet.com/).
To learn more, see [https://rspec-puppet.com/](https://rspec-puppet.com/).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the old documentatoin.
The new one is at https://puppetlabs.github.io/rspec-puppet/

Comment thread docs/_openvox_8x/bgtm.md

The [puppetlabs-spec-helper](https://github.com/puppetlabs/puppetlabs_spec_helper) gem automates some of the tasks required to test modules.

This is especially useful in conjunction with `rspec-puppet`, as `puppetlabs-spec-helper` provides default Rake tasks that allow you to standardize testing across modules. It also provides some code to connect `rspec-puppet` with modules. Add it to the Gemfile of the project, and then add the following line to the Rakefile:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a note, that this gem is no longer needed for any voxpupuli module.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moreover, this gem will bring puppet gem as a dependency IIRC

Comment thread docs/_openvox_8x/bgtm.md Outdated
[Serverspec](http://serverspec.org/) provides additional testing constructs (such as `be_running` and `be_installed`) for beaker-rspec. It allows you to abstract away details of the underlying distribution when testing. It lets you write tests like:
[Serverspec](https://serverspec.org/) provides additional testing constructs (such as `be_running` and `be_installed`) for beaker-rspec. It allows you to abstract away details of the underlying distribution when testing. It lets you write tests like:

describe service('httpd') do
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please surround code block by backticks

Comment thread docs/_openvox_8x/bgtm.md

For guidance, see our modules documentation [guide](./modules_documentation.html)and the [documentation](./style_guide.html#module-documentation) section of the Puppet Language Style Guide.
For guidance, see our modules documentation [guide](./modules_documentation.html) and the [documentation](./style_guide.html#module-documentation) section of the OpenVox Language Style Guide.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it is a valid point to mention https://www.puppetmodule.info so people can see how the documentation is rendered.

miharp added a commit to miharp/openvox-docs that referenced this pull request Apr 21, 2026
- Switch osfamily to structured fact os['family']
- Update rspec-puppet docs link to puppetlabs.github.io
- Add note that puppetlabs-spec-helper is no longer needed for Vox Pupuli modules
- Fix indented serverspec code block to fenced style
- Fix non-descriptive 'here' link text
- Add puppetmodule.info to community resources

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Switch osfamily to structured fact os['family']
- Update rspec-puppet docs link to puppetlabs.github.io
- Add note that puppetlabs-spec-helper is no longer needed for Vox Pupuli modules
- Fix indented serverspec code block to fenced style
- Fix non-descriptive 'here' link text
- Add puppetmodule.info to community resources

Signed-off-by: Michael Harp <mike@mikeharp.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@miharp miharp force-pushed the fix/bgtm-links-and-cleanup branch from e25379d to 8cd982f Compare April 21, 2026 13:22
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.

5 participants