On 7 October 2014 19:06, Hailee Kenney <hai...@puppetlabs.com> wrote:
> We're excited to announce the release of Puppet Strings 0.1.0! This is a
> preliminary release of the new documentation module. Our goal is to get it
> into the hands of users so that we can get feedback on what direction we
> should take this. The long-term goal is to have this tool eventually replace
> the current puppet doc implementation.
>
> Installation instructions are here:
> https://github.com/puppetlabs/puppetlabs-strings/blob/master/README.md
> The module can be found on the Puppet Forge here:
> https://forge.puppetlabs.com/puppetlabs/strings
>
> To track issues related to the release or file new issues, check out the
> PDOC project on JIRA:
>
> *JIRA Project: https://tickets.puppetlabs.com/browse/PDOC
> * 0.1.0 Tickets:
> https://tickets.puppetlabs.com/browse/PDOC/fixforversion/11923
>

Very nice.

I wanted to publish docs next a few repos on GitHub, using GitHub
pages. Thought this might be useful to a few other people:

echo "doc" >> .gitignore
/opt/boxen/homebrew/share/git-core/contrib/workdir/git-new-workdir . doc
cd doc
git checkout --orphan gh-pages
rm -fr .
cd ../
puppet strings
cd doc
git commit -am "fancy documentation"
git push -u origin gh-pages

Here's an example:

http://garethr.github.io/garethr-docker/
https://github.com/garethr/garethr-docker/

The interesting bit that I though made it worth posting was the use of
 git-new-workdir. Moving into the docs dir
switches to the correct branch automatically which is nice.

One minor bit of feedback. Is is possible to get syntax highlighting
of puppet code working in the text files, à la GitHub?

Here's to more well documented modules.

Gareth


> --
> Hailee Kenney
> hai...@puppetlabs.com
> Associate Software Developer, Puppet Labs
>
> --
> You received this message because you are subscribed to the Google Groups
> "Puppet Developers" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to puppet-dev+unsubscr...@googlegroups.com.
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/puppet-dev/CALdYGa9ZXqu8Avsan%3DYaLMqLGL4Z%3DvJiDq%3Df%2BqCRcMxJREa8Cg%40mail.gmail.com.
> For more options, visit https://groups.google.com/d/optout.



-- 
Gareth Rushgrove
@garethr

devopsweekly.com
morethanseven.net
garethrushgrove.com

-- 
You received this message because you are subscribed to the Google Groups 
"Puppet Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to puppet-dev+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/puppet-dev/CAFi_6yLHCAT2TQFmfgjrXMjH4f2KJZY-2AUd__jP0Fm4eOeL3w%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to