Jira (PDOC-79) [SPIKE] Define the set of tickets needed to get strings working for docs needs
Title: Message Title Steve Barlow created an issue Puppet Strings / PDOC-79 [SPIKE] Define the set of tickets needed to get strings working for docs needs Issue Type: Task Assignee: Unassigned Created: 2016/05/18 1:28 PM Priority: Normal Reporter: Steve Barlow Add Comment This message was sent by Atlassian JIRA (v6.4.13#64028-sha1:b7939e9) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. Fo
Jira (PDOC-79) [SPIKE] Define the set of tickets needed to get strings working for docs needs
Title: Message Title Steve Barlow updated an issue Puppet Strings / PDOC-79 [SPIKE] Define the set of tickets needed to get strings working for docs needs Change By: Steve Barlow One possibility: concentrate on using strings to fill in existing gaps. Add Comment This message was sent by Atlassian JIRA (v6.4.13#64028-sha1:b7939e9) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-79) [SPIKE] Define the set of tickets needed to get strings working for docs needs
Title: Message Title Steve Barlow updated an issue Puppet Strings / PDOC-79 [SPIKE] Define the set of tickets needed to get strings working for docs needs Change By: Steve Barlow Story Points: 2 Add Comment This message was sent by Atlassian JIRA (v6.4.13#64028-sha1:b7939e9) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-79) [SPIKE] Define the set of tickets needed to get strings working for docs needs
Title: Message Title Sean Griffin updated an issue Puppet Strings / PDOC-79 [SPIKE] Define the set of tickets needed to get strings working for docs needs Change By: Sean Griffin QA Status: Reviewed Add Comment This message was sent by Atlassian JIRA (v6.4.13#64028-sha1:b7939e9) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-79) [SPIKE] Define the set of tickets needed to get strings working for docs needs
Title: Message Title Henrik Lindberg updated an issue Puppet Strings / PDOC-79 [SPIKE] Define the set of tickets needed to get strings working for docs needs Change By: Henrik Lindberg One possibility: concentrate on using strings to fill in existing gaps :* 4 . x Functions are not processed (the pressing need since we otherwise have to maintain dummy copies in a different format) Add Comment This message was sent by Atlassian JIRA (v6.4.13#64028-sha1:b7939e9) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-79) [SPIKE] Define the set of tickets needed to get strings working for docs needs
Title: Message Title Steve Barlow updated an issue Puppet Strings / PDOC-79 [SPIKE] Define the set of tickets needed to get strings working for docs needs Change By: Steve Barlow Sprint: Language 2016-06-01 , Language 2016-06-15 Add Comment This message was sent by Atlassian JIRA (v6.4.13#64028-sha1:b7939e9) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-79) [SPIKE] Define the set of tickets needed to get strings working for docs needs
Title: Message Title Eric Sorenson updated an issue Puppet Strings / PDOC-79 [SPIKE] Define the set of tickets needed to get strings working for docs needs I ran strings against the lib/puppet/functions/ directory and got a spray of errors. It did produce docs but they are garbled and not many strings are rendered, see attached screenshot. I've included a tar.gz of the generated directory in case that helps anyone. Change By: Eric Sorenson Attachment: Screenshot 2016-06-01 13.19.31.png Attachment: puppet-strings-functions-4.5.0.tar.gz Add Comment This message was sent by Atlassian JIRA (v6.4.13#64028-sha1:b7939e9) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-b
Jira (PDOC-79) [SPIKE] Define the set of tickets needed to get strings working for docs needs
Title: Message Title Steve Barlow updated an issue Puppet Strings / PDOC-79 [SPIKE] Define the set of tickets needed to get strings working for docs needs Change By: Steve Barlow Sprint: Language 2016-06-01, Language 2016-06- 15 29 Add Comment This message was sent by Atlassian JIRA (v6.4.13#64028-sha1:b7939e9) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-79) [SPIKE] Define the set of tickets needed to get strings working for docs needs
Title: Message Title Steve Barlow updated an issue Puppet Strings / PDOC-79 [SPIKE] Define the set of tickets needed to get strings working for docs needs Change By: Steve Barlow Flagged: Impediment Add Comment This message was sent by Atlassian JIRA (v6.4.13#64028-sha1:b7939e9) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-79) [SPIKE] Define the set of tickets needed to get strings working for docs needs
Title: Message Title Henrik Lindberg updated an issue Puppet Strings / PDOC-79 [SPIKE] Define the set of tickets needed to get strings working for docs needs Change By: Henrik Lindberg Sprint: Language 2016-06-01, Language 2016- 06 07 - 29 13 Add Comment This message was sent by Atlassian JIRA (v6.4.13#64028-sha1:b7939e9) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-79) [SPIKE] Define the set of tickets needed to get strings working for docs needs
Title: Message Title Hailee Kenney commented on PDOC-79 Re: [SPIKE] Define the set of tickets needed to get strings working for docs needs So for what it's worth the screenshot provided isn't quite an accurate representation of what the strings output will look like for our functions. I ran strings only against the "new" function (specifically the 3.x stub in `lib/puppet/parser/functions` since it contains the actual documentation string) where I set the "--markup markdown" option in the .yardopts file and it looks much better (see attached screenshot). The issue here is that YARD by default will assume it's parsing rdoc (which is why the previous screenshot looks so unreadable), when we want it to parse our comments and Markdown. This is usually dealt with by adding a .yardopts file in the root of the module directory which specifies the Markdown option. I'm not quite sure how we want to deal with this in regards to running against core puppet since we don't want to be dropping .yardopts files everywhere. We will probably have to figure out another way to pass this setting to YARD. This can't be done via the command line because since strings is a face, all arguments are parsed as puppet arguments. Add Comment This message was sent by Atlassian JIRA (v6.4.13#64028-sha1:b7939e9) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-79) [SPIKE] Define the set of tickets needed to get strings working for docs needs
Title: Message Title Hailee Kenney updated an issue Puppet Strings / PDOC-79 [SPIKE] Define the set of tickets needed to get strings working for docs needs Change By: Hailee Kenney Attachment: Screen Shot 2016-06-20 at 1.23.06 PM.png Add Comment This message was sent by Atlassian JIRA (v6.4.13#64028-sha1:b7939e9) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-79) [SPIKE] Define the set of tickets needed to get strings working for docs needs
Title: Message Title Henrik Lindberg commented on PDOC-79 Re: [SPIKE] Define the set of tickets needed to get strings working for docs needs I seriously doubt that any of the entities being documented by puppet-strings will encounter deliberate rdoc markup that is not also working with markdown. Can we enforce markdown in puppet-string? Ideally allowing it to be modified by a user that opts in to having .yardopts in their module. Add Comment This message was sent by Atlassian JIRA (v6.4.13#64028-sha1:b7939e9) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-79) [SPIKE] Define the set of tickets needed to get strings working for docs needs
Title: Message Title Steve Barlow updated an issue Puppet Strings / PDOC-79 [SPIKE] Define the set of tickets needed to get strings working for docs needs Change By: Steve Barlow Flagged: Impediment Add Comment This message was sent by Atlassian JIRA (v6.4.13#64028-sha1:b7939e9) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-79) [SPIKE] Define the set of tickets needed to get strings working for docs needs
Title: Message Title Steve Barlow updated an issue Puppet Strings / PDOC-79 [SPIKE] Define the set of tickets needed to get strings working for docs needs Change By: Steve Barlow Sprint: Language 2016-06-01, Language 2016-07- 13 27 Add Comment This message was sent by Atlassian JIRA (v6.4.13#64028-sha1:b7939e9) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-79) [SPIKE] Define the set of tickets needed to get strings working for docs needs
Title: Message Title Steve Barlow updated an issue Puppet Strings / PDOC-79 [SPIKE] Define the set of tickets needed to get strings working for docs needs Change By: Steve Barlow Sprint: Language 2016-06-01, Language 2016- 07 08 - 27 10 (3rd 1.6.0 Add Comment This message was sent by Atlassian JIRA (v6.4.13#64028-sha1:b7939e9) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-79) [SPIKE] Define the set of tickets needed to get strings working for docs needs
Title: Message Title Henrik Lindberg updated an issue Puppet Strings / PDOC-79 [SPIKE] Define the set of tickets needed to get strings working for docs needs Change By: Henrik Lindberg Sprint: Language 2016-06-01, Language 2016-08- 10 (3rd 1.6.0 24 Add Comment This message was sent by Atlassian JIRA (v6.4.13#64028-sha1:b7939e9) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-79) [SPIKE] Define the set of tickets needed to get strings working for docs needs
Title: Message Title Steve Barlow updated an issue Puppet Strings / PDOC-79 [SPIKE] Define the set of tickets needed to get strings working for docs needs Change By: Steve Barlow Sprint: Language 2016-06-01 , Language 2016-08-24 Add Comment This message was sent by Atlassian JIRA (v6.4.13#64028-sha1:b7939e9) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-79) [SPIKE] Define the set of tickets needed to get strings working for docs needs
Title: Message Title Peter Huene assigned an issue to Peter Huene Puppet Strings / PDOC-79 [SPIKE] Define the set of tickets needed to get strings working for docs needs Change By: Peter Huene Assignee: Peter Huene Add Comment This message was sent by Atlassian JIRA (v6.4.13#64028-sha1:b7939e9) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-79) [SPIKE] Define the set of tickets needed to get strings working for docs needs
Title: Message Title Peter Huene assigned an issue to Unassigned Puppet Strings / PDOC-79 [SPIKE] Define the set of tickets needed to get strings working for docs needs Change By: Peter Huene Assignee: Peter Huene Add Comment This message was sent by Atlassian JIRA (v6.4.13#64028-sha1:b7939e9) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
