Jira (PDOC-161) As a developer I want to programmatically retrieve the name and short description from a puppet class
Title: Message Title William Hopper updated an issue Puppet Strings / PDOC-161 As a developer I want to programmatically retrieve the name and short description from a puppet class Change By: William Hopper Fix Version/s: PDOC 1.1.0 Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- 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-161) As a developer I want to programmatically retrieve the name and short description from a puppet class
Title: Message Title Jeremy Adams commented on PDOC-161 Re: As a developer I want to programmatically retrieve the name and short description from a puppet class +1 to a tag called summary that will appear at least in the context of puppet classes, though I wouldn't be opposed to it showing up in the other types as well: "puppet_classes": [ ], "defined_types": [ ], "resource_types": [ ], "providers": [ ], "puppet_functions": [ ] }
Jira (PDOC-161) As a developer I want to programmatically retrieve the name and short description from a puppet class
Title: Message Title Lindsey Smith updated an issue Puppet Strings / PDOC-161 As a developer I want to programmatically retrieve the name and short description from a puppet class Change By: Lindsey Smith *Use Case:* Vendors like VMware would like a way to discover a list of role classes along with a description of the class. Right now they can pull a class name, but there isn't a standard way to retrieve a short description. puppet-strings is used to document puppet files, but it's also a great way to get easily parseable metadata about a puppet file via the JSON output option(s).*The Issue:* You can get the name from puppet-strings, but puppet-strings (and YARD itself) doesn't have a simple tag for a short description. There is the generic docstring text, but it's freeform and can be multiple lines. It's not ideal.*Solution:* Create a new puppet-strings-specific YARD "summary" tag (similar to puppet.type.param) for storing a short description with a recommended limit of 140 characters. This field should show up in the JSON output. Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- 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-161) As a developer I want to programmatically retrieve the name and short description from a puppet class
Title: Message Title William Hopper updated an issue Puppet Strings / PDOC-161 As a developer I want to programmatically retrieve the name and short description from a puppet class Change By: William Hopper Story Points: 2 Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- 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-161) As a developer I want to programmatically retrieve the name and short description from a puppet class
Title: Message Title Lindsey Smith updated an issue Puppet Strings / PDOC-161 As a developer I want to programmatically retrieve the name and short description from a puppet class Change By: Lindsey Smith *Use Case:* Vendors like VMware would like a way to discover a list of role classes along with a description of the class. Right now they can pull a class name, but there isn't a standard way to retrieve a short description. puppet-strings is used to document puppet files, but it's also a great way to get easily parseable metadata about a puppet file via the JSON output option(s).*The Issue:* You can get the name from puppet-strings, but puppet-strings (and YARD itself) doesn't have a simple tag for a short description. There is the generic docstring text, but it's freeform and can be multiple lines. It's not ideal.* Proposed Solution:* Create a new puppet-strings-specific YARD tag (similar to puppet.type.param) for storing a short description with a recommended limit of 50-80 140 characters. This field should show up in the JSON output. Optionally the field can show up in the HTML. Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- 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
Jira (PDOC-161) As a developer I want to programmatically retrieve the name and short description from a puppet class
Title: Message Title Lindsey Smith commented on PDOC-161 Re: As a developer I want to programmatically retrieve the name and short description from a puppet class I chatted with David Schmitt and we decided that we do want a standard tag built-in so that multiple solutions can take advantage of the class short name. The burden of coping with the constraints of the tag will be on the consuming solution (VRA, Foreman, PE GUI eventually, etc.). For our part we'd want to evangelize its existence so that consuming solutions have content to take advantage of. Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- 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-161) As a developer I want to programmatically retrieve the name and short description from a puppet class
Title: Message Title Lindsey Smith updated an issue Puppet Strings / PDOC-161 As a developer I want to programmatically retrieve the name and short description from a puppet class Change By: Lindsey Smith * Use Case: * Vendors like VMware would like a way to discover a list of role classes along with a description of the class. Right now they can pull a class name, but there isn't a standard way to retrieve a short description. puppet-strings is used to document puppet files, but it's also a great way to get easily parseable metadata about a puppet file via the JSON output option(s). * The Issue: * You can get the name from puppet-strings, but puppet-strings (and YARD itself) doesn't have a simple tag for a short description. There is the generic docstring text, but it's freeform and can be multiple lines. It's not ideal. * Proposed Solution: * Create a new puppet-strings-specific YARD tag (similar to puppet.type.param) for storing a short description with a limit of 50-80 characters. This field should show up in the JSON output. Optionally the field can show up in the HTML. Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- 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-161) As a developer I want to programmatically retrieve the name and short description from a puppet class
Title: Message Title David Schmitt commented on PDOC-161 Re: As a developer I want to programmatically retrieve the name and short description from a puppet class a generic tag is ineffective from both ends of the problem: role and profile classes (which seem to be the primary target here) are written specifically for VRA estates, a generic tag doesn't help. In my experience UI-specific restrictions will be violated by innocent users of generic constructs, thereby leading to sub-optimal results (clipping, lack of information, etc). Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- 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-161) As a developer I want to programmatically retrieve the name and short description from a puppet class
Title: Message Title Lindsey Smith commented on PDOC-161 Re: As a developer I want to programmatically retrieve the name and short description from a puppet class Why wouldn't a generic summary tag be sufficient? If it's well-known and you add it to your role classes, then the VRA use case would be satisfied without, as far as I can tell, negatively impacting the same tag at the component module or profile class levels. Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- 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-161) As a developer I want to programmatically retrieve the name and short description from a puppet class
Title: Message Title David Schmitt commented on PDOC-161 Re: As a developer I want to programmatically retrieve the name and short description from a puppet class Jeremy Adams asked me about this last week, and we discussed a range of options. As far as we could tell, there is no way to add tags without adding a few lines of ruby to the yard processor, therefore this is necessary. Given the target group (VRA users and their role classes) and purpose (UI specific markup), a tag along the lines of puppet.vra.description made the most sense. Other options discussed were generic summary tag: does not really help roles & profiles; why constrain it to VRA UI requirements? parse out first line/paragraph: makes parsing/consuming harder; not socialized (although git commit messages set precedent); likely will violate UI limitations. Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- 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-161) As a developer I want to programmatically retrieve the name and short description from a puppet class
Title: Message Title Lindsey Smith updated an issue Puppet Strings / PDOC-161 As a developer I want to programmatically retrieve the name and short description from a puppet class Change By: Lindsey Smith Team: Puppet Developer Experience Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- 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-161) As a developer I want to programmatically retrieve the name and short description from a puppet class
Title: Message Title Lindsey Smith commented on PDOC-161 Re: As a developer I want to programmatically retrieve the name and short description from a puppet class Hailee Kenney, William Hopper, Peter Huene: any reasons why the proposed solution isn't the way to go? Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- 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-161) As a developer I want to programmatically retrieve the name and short description from a puppet class
Title: Message Title Abir Majumdar updated an issue Puppet Strings / PDOC-161 As a developer I want to programmatically retrieve the name and short description from a puppet class Change By: Abir Majumdar Use Case:Vendors like VMware would like a way to discover a list of role classes along with a description of the class. Right now they can pull a class name, but there isn't a standard way to retrieve a short description. puppet-strings is used to document puppet files, but it's also a great way to get easily parseable metadata about a puppet file via the JSON output option(s).The Issue: You can get the name from puppet-strings , but puppet-strings (and YARD itself) doesn't have a simple tag for a short description. There is the generic docstring text, but it's freeform and can be multiple lines. It's not ideal.Proposed Solution:Create a new puppet-strings-specific YARD tag (similar to puppet.type.param) for storing a short description with a limit of 50-80 characters. This field should show up in the JSON output. Optionally the field can show up in the HTML. Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- 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-161) As a developer I want to programmatically retrieve the name and short description from a puppet class
Title: Message Title Abir Majumdar updated an issue Puppet Strings / PDOC-161 As a developer I want to programmatically retrieve the name and short description from a puppet class Change By: Abir Majumdar Use Case:Vendors like VMware would like a way to discover a list of role classes along with a description of the class. Right now they can pull a class name, but there isn't a standard way to retrieve a short description. puppet-strings is used to document puppet files, but it's also a great way to get easily parseable metadata about a puppet file via the JSON output option(s).The Issue: puppet-strings (and YARD itself) doesn't have a simple tag for a short description. There is the generic docstring text, but it's freeform and can be multiple lines. It's not ideal.Proposed Solution:Create a new puppet-strings-specific YARD tag (similar to puppet.type.param) for storing a short description with a limit of 50-80 characters. This field should show up in the JSON output. Optionally the field can show up in the HTML. Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- 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-161) As a developer I want to programmatically retrieve the name and short description from a puppet class
Title: Message Title Abir Majumdar updated an issue Puppet Strings / PDOC-161 As a developer I want to programmatically retrieve the name and short description from a puppet class Change By: Abir Majumdar Use Case:Vendors like VMware would like a way to discover a list of role classes along with a description of the class. Right now they can pull a class name, but there isn't a standard way to retrieve a short description. puppet-strings is used to document puppet files, but it's also a great way to get easily parseable metadata about a puppet file via the JSON output option(s).The Issue: puppet-strings (and YARD itself) doesn't have a simple tag for a short description. There is the generic docstring text, but it's freeform and can be multiple lines. It's not ideal.Proposed Solution:Create a new puppet-strings-specific YARD tag (similar to puppet.type.param) for storing a short description with a limit of 50-80 characters. This field should show up in the HTML and the JSON output. Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- 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-161) As a developer I want to programmatically retrieve the name and short description from a puppet class
Title: Message Title Abir Majumdar updated an issue Puppet Strings / PDOC-161 As a developer I want to programmatically retrieve the name and short description from a puppet class Change By: Abir Majumdar Summary: As a developer I want to programmatically retrieve the name and short description from a puppet file. class Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- 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.
