Jira (PDOC-273) puppet-strings should pull documentation from the lib folder too

[Gene Liverman (JIRA)]

Gene Liverman created an issue

Puppet Strings / PDOC-273 puppet-strings should pull documentation from the lib folder too Issue Type: Bug Assignee: Unassigned Created: 2019/02/04 6:59 AM Priority: Normal Reporter: Gene Liverman As a module author I write my documentation in a format compatible with puppet strings. I expect that when I run puppet strings generate that all that documentation will end up in REFERENCE.md however none of the docs that I write on the ruby files in the lib folder are processed. The end result of this is a need to manually document part of my module while having the rest of the docs auto-generated.  Add Comment

This message was sent by Atlassian JIRA (v7.7.1#77002-sha1:e75ca93)

[Gene Liverman (JIRA)]

Gene Liverman commented on PDOC-273

Re: puppet-strings should pull documentation from the lib folder too An example of a module where parts of it get documented and others don't is https://github.com/ploperations/ploperations-classification  An example of puppet strings providing zero help is https://github.com/ploperations/ploperations-consul_data

Add Comment

[Gene Liverman (JIRA)]

Gene Liverman updated an issue

Puppet Strings / PDOC-273

puppet-strings should pull documentation from the lib folder too

Change By: Gene Liverman Labels: customer0

Add Comment

[Gene Liverman (JIRA)]

Gene Liverman commented on PDOC-273

Re: puppet-strings should pull documentation from the lib folder too Pinging Kris Bosland

Add Comment

[Kris Bosland (JIRA)]

Kris Bosland updated an issue

Puppet Strings / PDOC-273

puppet-strings should pull documentation from the lib folder too

Change By: Kris Bosland Sprint: Platform Core KANBAN

Add Comment

[Kris Bosland (JIRA)]

Kris Bosland assigned an issue to Kris Bosland

Puppet Strings / PDOC-273 puppet-strings should pull documentation from the lib folder too

Change By: Kris Bosland Assignee: Kris Bosland

Add Comment

[Kris Bosland (JIRA)]

Kris Bosland updated an issue

Puppet Strings / PDOC-273 puppet-strings should pull documentation from the lib folder too

Change By: Kris Bosland Team: Coremunity

Add Comment

[Gene Liverman (JIRA)]

Gene Liverman commented on PDOC-273

Re: puppet-strings should pull documentation from the lib folder too I have been updating the docs for another module and noticed that not all the tags listed in https://puppet.com/docs/puppet/6.0/puppet_strings.html are actually picked up from ruby functions.

Add Comment

[Jorie Tappa (JIRA)]

Jorie Tappa updated an issue

Puppet Strings / PDOC-273

puppet-strings should pull documentation from the lib folder too

Change By: Jorie Tappa Sprint: Platform Core KANBAN

Add Comment

[Gene Liverman (JIRA)]

Gene Liverman commented on PDOC-273

Re: puppet-strings should pull documentation from the lib folder too Jorie Tappa - I saw that you made a small edit on this and was curious where it sat on the priority list.

Add Comment

[Jorie Tappa (JIRA)]

Jorie Tappa commented on PDOC-273

Re: puppet-strings should pull documentation from the lib folder too

Hi Gene Liverman, we removed this from our active sprint because it's not currently being worked on, and right now we're focusing our efforts on higher priority bugs and features. Kris will update the ticket when he's actively working on it again.

Add Comment

[Gene Liverman (JIRA)]

Gene Liverman commented on PDOC-273

Re: puppet-strings should pull documentation from the lib folder too

Thanks for the info Jorie Tappa!

Add Comment

[Josh Cooper (JIRA)]

Josh Cooper updated an issue

Puppet Strings / PDOC-273

puppet-strings should pull documentation from the lib folder too

Change By: Josh Cooper Team: Coremunity

Add Comment