Fix broken links and update community resources in bgtm.md#67
Fix broken links and update community resources in bgtm.md#67miharp wants to merge 2 commits intoOpenVoxProject:masterfrom
Conversation
410041b to
c78f318
Compare
| The [puppet-users mailing list](https://groups.google.com/forum/#!forum/puppet-users) | ||
| [The Forge](https://forge.puppet.com) | ||
|
|
||
| `#puppet` on IRC |
There was a problem hiding this comment.
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.
0f05da2 to
3e56ae0
Compare
- 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>
3e56ae0 to
9cc94d7
Compare
| ```` | ||
| ``` | ||
|
|
||
| RSpec lets you provide facts, like `osfamily`, in order to test the module in various scenarios. |
There was a problem hiding this comment.
Please switch to new structured facts os['family']
| 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/). |
There was a problem hiding this comment.
This is the old documentatoin.
The new one is at https://puppetlabs.github.io/rspec-puppet/
|
|
||
| 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: |
There was a problem hiding this comment.
Please add a note, that this gem is no longer needed for any voxpupuli module.
There was a problem hiding this comment.
Moreover, this gem will bring puppet gem as a dependency IIRC
| [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 |
There was a problem hiding this comment.
Please surround code block by backticks
|
|
||
| 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. | ||
|
|
There was a problem hiding this comment.
Maybe it is a valid point to mention https://www.puppetmodule.info so people can see how the documentation is rendered.
- 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>
e25379d to
8cd982f
Compare
Summary
http://→https://for Forge, rspec-puppet, Vagrant, and Serverspec URLsrubytopuppetfor Puppet code examples; addrubyhint to RSpec/Rakefile examples{:.concept}/{:.section}kramdown markers unused by the current themeTest plan
bundle exec jekyll buildcompletes without errors/openvox/8.x/bgtm.html🤖 Generated with Claude Code