https://github.com/voxpupuli/puppetmodule.info

Puppet module documentation website
https://github.com/voxpupuli/puppetmodule.info

Last synced: about 1 month ago
JSON representation

Puppet module documentation website

• Host: GitHub
• URL: https://github.com/voxpupuli/puppetmodule.info
• Owner: voxpupuli
• License: mit
• Created: 2017-01-17T10:48:15.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-04-12T13:13:43.000Z (8 months ago)
• Last Synced: 2024-10-29T14:22:44.782Z (about 1 month ago)
• Language: Ruby
• Homepage: https://puppetmodule.info
• Size: 727 KB
• Stars: 11
• Watchers: 3
• Forks: 2
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: MIT-LICENSE

Awesome Lists containing this project

• awesome-puppet - Source - Available on GitHub. (Learning)
• awesome-puppet - Source - Available on GitHub. (Learning)

README

        
PuppetModule.info: Puppet Strings Doc Server

============================================

PuppetModule.info is the next generation Puppet module doc server.

This doc server uses YARD to generate project documentation on the fly, for

both published Puppet modules as well as GitHub projects.

The public doc server is hosted at [http://puppetmodule.info](http://puppetmodule.info)

It relies on:

* [Puppet Strings](https://github.com/puppetlabs/puppet-strings)

* [RubyDoc.info](https://github.com/docmeta/rubydoc.info)

* [YARD](https://github.com/lsegal/yard)

Getting Started

---------------

This site is a public service and is community-supported. Patches and

enhancements are welcome.

Running the doc server locally is easy:

```

git clone git://github.com/voxpupuli/puppetmodule.info

cd puppetmodule.info

bundle config --local path .vendor/

bundle install

bundle exec rake modules:update

bundle exec puma --config config/puma.rb

```

Rake tasks

----------

Important rake tasks for deployment:

* `rake modules:update MODULE_UPDATER_PARTIAL=true` - run regularly (hourly)

  to scrape the latest module releases from Puppet Forge.

* `rake modules:update` - run infrequently (daily) to check all known Forge

  modules, for deletions etc.

For development:

* `rake modules:update MODULE_UPDATER_LIMIT=true` - import only the first page

  of Forge modules for a small dataset, fast and reduces load.

Thanks

------

PuppetModule.info was authored and maintained by Dominic Cleal, and is unaffiliated to Puppet.

RubyDoc.info was created by Loren Segal (YARD) and Nick Plante (rdoc.info) and is a project of DOCMETA, LLC.

Additional help was provided by [YARD's friendly developer community](https://github.com/lsegal/rubydoc.info/graphs/contributors).

Dominic ran the site for years, until he donated it to Vox Pupuli.

Pull requests welcome!

(c) 2015 DOCMETA LLC, 2017 Dominic Cleal, 2022-2023 Vox Pupuli. This code is distributed under the MIT license.