puppet strings workflow

[hm...@t-hamel.fr]

Hello,

I'm trying to setup a documentation workflow based on puppet-strings and I have some questions.

1) Is this too early? Should I stick to a plain README file?

2) Is there any public module that is considered to follow best practice right now? My question is where can I find a real life example of a module documented with puppet-strings?

3) I can't figure out how the documentation generated with puppet strings can be presented in a standard manner, I have the impression that module reference should be in the README, but I can't find a way to automatically generate it from the comments in .pp files. Copying the documentation from a puppet strings export to the README manually is really not something I'm eager to do.

Regards

Thomas HAMEL

[Gareth Rushgrove]

Hi Hamel

I've been using Strings for a bit and find it more useful than
documenting the classes and params by hand, as well as much quicker.

I've mainly been using GitHub pages to host the resulting docs, so for instance:

http://puppetlabs.github.io/puppetlabs-docker_platform/

Gareth

> --
> You received this message because you are subscribed to the Google Groups
> "Puppet Users" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to puppet-users...@googlegroups.com.
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/puppet-users/dff001d8-2ddc-4fd7-8c64-19821dd9a941%40googlegroups.com.
> For more options, visit https://groups.google.com/d/optout.



--
Gareth Rushgrove
@garethr

devopsweekly.com
morethanseven.net
garethrushgrove.com

[hm...@t-hamel.fr]

On Monday, June 20, 2016 at 7:21:18 PM UTC+2, garethr wrote:

On 20 June 2016 at 10:14,  <hm...@t-hamel.fr> wrote:

> 2) Is there any public module that is considered to follow best practice
> right now? My question is where can I find a real life example of a module
> documented with puppet-strings?

I've been using Strings for a bit and find it more useful than
documenting the classes and params by hand, as well as much quicker.

I've mainly been using GitHub pages to host the resulting docs, so for instance:

http://puppetlabs.github.io/puppetlabs-docker_platform/

Thanks, that's helpfull. I see you are using rdoc though. The puppet strings README is kind of encouraging to use markdown. Is there any other example using markdown?

Thomas