Here are a few other items passed along to me: * There's no way to make strings stop trying to add it's own default class parameters. $::foo::params::bar isn't a very useful default besides to say "g look at the code".
* There wasn't a current way to document inline code and some of the YARD parameters don't map well to Puppet code. * Rendering legacy RDoc works, but renders dumb html instead of the current puppet doc output which hurts when documenting class parameters. I think that there are bugs reported out there for most of this but I ran strings this morning and ran into most of them still. Thanks, Trevor On Sat, Aug 29, 2015 at 1:05 AM, Trevor Vaughan <tvaug...@onyxpoint.com> wrote: > Hi Lindsey, > > These may be fixed (hoping!) > > 1) The ability to run it as a Gem > > 2) The ability to generate docs for all of your modules without 'strings' > being part of the bunch (see #1) > > 3) The ability to point at a directory and have strings just parse > everything without needing to have it in your modulepath (see #1) > > 4) If you're using RVM (or something like it), you'll run into issues with > Gems and Gempaths unless you do some fancy shenanigans with your modulepath > (which I've never gotten to work properly) > > 5) I haven't been able to successfully get it to output a consolidated > document set containing all of my modules which are formatted in the legacy > style. > > Also, it sticks cruft all over my modules when I'd much rather be able to > stick the docs all together in a single location. > > 100% willing to admit that I might be doing something wrong here but the > way that I *expect* it to work is: > > $ puppet-strings /path/to/my/development/stack/modules > > Output: puppet_doc/index.html <and other stuff> > > Faces are fun until you start trying to use them across 3 different > versions of Ruby and not have them inject into your working module set. > > Thanks, > > Trevor > > On Fri, Aug 28, 2015 at 9:56 PM, Lindsey Smith <l.sm...@puppetlabs.com> > wrote: > >> >> >> On Fri, Aug 28, 2015 at 5:53 PM, Trevor Vaughan <tvaug...@onyxpoint.com> >> wrote: >> >>> Hi Leam, >>> >>> We use Git Submodules to collect our various modules together and add >>> comments to the headers of the files. >>> >>> Unfortunately, 'puppet doc' was deprecated and 'strings' isn't quite >>> ready for prime time. >>> >> >> What do you think is missing from puppet strings? >> >> >>> >>> The new skeleton suggests moving all of the information to a README.md >>> in each module and we're slowly getting there but it's quite time consuming. >>> >>> Trevor >>> >>> On Fri, Aug 28, 2015 at 5:00 PM, leam hall <leamh...@gmail.com> wrote: >>> >>>> I'm wondering how people track large lists of modules, to ensure new >>>> team members know which does what, when the last time a module was reviewed >>>> for usefulness, etc. How do you handle growth and complexity? >>>> >>>> Leam >>>> >>>> >>>> -- >>>> Mind on a Mission <http://leamhall.blogspot.com/> >>>> >>>> -- >>>> You received this message because you are subscribed to the Google >>>> Groups "Puppet Users" group. >>>> To unsubscribe from this group and stop receiving emails from it, send >>>> an email to puppet-users+unsubscr...@googlegroups.com. >>>> To view this discussion on the web visit >>>> https://groups.google.com/d/msgid/puppet-users/CACv9p5oKQNhGSxe9JFbrofTes3Z_bievoea6gs7U%2BZ0sK0FYag%40mail.gmail.com >>>> <https://groups.google.com/d/msgid/puppet-users/CACv9p5oKQNhGSxe9JFbrofTes3Z_bievoea6gs7U%2BZ0sK0FYag%40mail.gmail.com?utm_medium=email&utm_source=footer> >>>> . >>>> For more options, visit https://groups.google.com/d/optout. >>>> >>> >>> >>> >>> -- >>> Trevor Vaughan >>> Vice President, Onyx Point, Inc >>> (410) 541-6699 >>> >>> -- This account not approved for unencrypted proprietary information -- >>> >>> -- >>> You received this message because you are subscribed to the Google >>> Groups "Puppet Users" group. >>> To unsubscribe from this group and stop receiving emails from it, send >>> an email to puppet-users+unsubscr...@googlegroups.com. >>> To view this discussion on the web visit >>> https://groups.google.com/d/msgid/puppet-users/CANs%2BFoXCi-gVKVp6wgL2VTo%2BWQ13y3FHLsGuUoPKzGOD98ywEA%40mail.gmail.com >>> <https://groups.google.com/d/msgid/puppet-users/CANs%2BFoXCi-gVKVp6wgL2VTo%2BWQ13y3FHLsGuUoPKzGOD98ywEA%40mail.gmail.com?utm_medium=email&utm_source=footer> >>> . >>> >>> For more options, visit https://groups.google.com/d/optout. >>> >> >> -- >> You received this message because you are subscribed to the Google Groups >> "Puppet Users" group. >> To unsubscribe from this group and stop receiving emails from it, send an >> email to puppet-users+unsubscr...@googlegroups.com. >> To view this discussion on the web visit >> https://groups.google.com/d/msgid/puppet-users/CAPyei8XedeyxUHTVoPCO8frpZ7qz0bZsA_uu7aFfVjZ_8qmZRQ%40mail.gmail.com >> <https://groups.google.com/d/msgid/puppet-users/CAPyei8XedeyxUHTVoPCO8frpZ7qz0bZsA_uu7aFfVjZ_8qmZRQ%40mail.gmail.com?utm_medium=email&utm_source=footer> >> . >> >> For more options, visit https://groups.google.com/d/optout. >> > > > > -- > Trevor Vaughan > Vice President, Onyx Point, Inc > (410) 541-6699 > > -- This account not approved for unencrypted proprietary information -- > -- Trevor Vaughan Vice President, Onyx Point, Inc (410) 541-6699 -- This account not approved for unencrypted proprietary information -- -- You received this message because you are subscribed to the Google Groups "Puppet Users" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-users+unsubscr...@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/puppet-users/CANs%2BFoWjp3EqaqVoyj3CfmzyBDOD5nOi31pGmcwOtWtPCqQObw%40mail.gmail.com. For more options, visit https://groups.google.com/d/optout.
