Generate reference documentation using Puppet Strings

cyberark / conjur-puppet

Official Puppet module for CyberArk Conjur

https://forge.puppet.com/cyberark/conjur

Apache License 2.0

6 stars 3 forks source link

Generate reference documentation using Puppet Strings #166

Closed izgeri closed 4 years ago

izgeri commented 4 years ago

Puppet strings can be used to automatically generic REFERENCE.md documentation based on specially formatted comments of Puppet classes, types, and resources.

In this card, we'll migrate the existing REFERENCE content to comments so that it can be generated using Puppet strings, and going forward the code comments can be maintained and used to auto update the REFERENCE file.

AC:

[ ] REFERENCE.md is generated by code comments using puppet strings

izgeri commented 4 years ago

@sgnn7 I think this issue is done already, right? I see gen_docs.sh is using puppet strings

sgnn7 commented 4 years ago

Not quite - I was having some issues running this command with the bleeding-edge PDK and I want to ensure this still works. There's also a question if we want this documentation to be generated on-the-fly during releases and be excluded from the repo by default.

sgnn7 commented 4 years ago

Closed via https://github.com/cyberark/conjur-puppet/pull/225.