Announce: Puppet Strings 0.1.0 Released

[Hailee Kenney]

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

--

Hailee Kenney

hai...@puppetlabs.com

Associate Software Developer, Puppet Labs

[Daniele Sluijters]

First, congratulations this is awesome and will make a lot of people very happy!

Second, typo in the README: puppet strings serever, that's one 'e' too many.

Third, is there an example module annotated with yard-style documentation to give a people an idea of how to get this going? Some examples in the README would also work.

Fourth, the Project URL on the Forge points to JIRA, I would expect that to point to Github and the Report Issues to point to JIRA (which is does).

[Hailee Kenney]

On Tue, Oct 7, 2014 at 7:06 PM, Daniele Sluijters <daniele....@gmail.com> wrote:

First, congratulations this is awesome and will make a lot of people very happy!

 

Thanks, that's great to hear!

Second, typo in the README: puppet strings serever, that's one 'e' too many.

Quite a few people noticed this typo, it's officially been fixed in the repository. That change just hasn't made it up to the Forge yet. 

Third, is there an example module annotated with yard-style documentation to give a people an idea of how to get this going? Some examples in the README would also work.

That's a good point, we'll try to come up with some examples of recommended documentation style. 

Fourth, the Project URL on the Forge points to JIRA, I would expect that to point to Github and the Report Issues to point to JIRA (which is does).

As above, a pull request was also opened for that issue and has been merged. :)

--
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+...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/puppet-dev/870b8c65-fd60-42b9-8277-c51bd1fe71b9%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Gareth Rushgrove]

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+...@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