[Puppet - Feature #16426] Publish API documentation automatically
Issue #16426 has been updated by Charlie Sharpsteen. Keywords changed from documentation docs yard API backlog to documentation docs yard API backlog customer Feature #16426: Publish API documentation automatically https://projects.puppetlabs.com/issues/16426#change-88302 * Author: Andrew Parker * Status: Merged - Pending Release * Priority: Immediate * Assignee: Michael Hall * Category: API * Target version: 3.1.0 * Affected Puppet version: * Keywords: documentation docs yard API backlog customer * Branch: At the moment there is no generated documentation that we automatically publish. This limits our ability to document and publish the public API for using puppet as a library or accessing supported features when writing extensions. There have been some attempts in the past to generate YARD docs and publish them to github as gh-pages, but that effort bit-rotted. We need to come up with a way of creating and maintaining these kinds of docs. -- You have received this notification because you have either subscribed to it, or are involved in it. To change your notification preferences, please click here: http://projects.puppetlabs.com/my/account -- 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 http://groups.google.com/group/puppet-bugs?hl=en. For more options, visit https://groups.google.com/groups/opt_out.
[Puppet - Feature #16426] Publish API documentation automatically
Issue #16426 has been updated by eric sorenson. Keywords changed from documentation, docs, yard, API to documentation docs yard API backlog Feature #16426: Publish API documentation automatically https://projects.puppetlabs.com/issues/16426#change-78390 Author: Andrew Parker Status: Investigating Priority: Normal Assignee: Andrew Parker Category: API Target version: Affected Puppet version: Keywords: documentation docs yard API backlog Branch: At the moment there is no generated documentation that we automatically publish. This limits our ability to document and publish the public API for using puppet as a library or accessing supported features when writing extensions. There have been some attempts in the past to generate YARD docs and publish them to github as gh-pages, but that effort bit-rotted. We need to come up with a way of creating and maintaining these kinds of docs. -- You have received this notification because you have either subscribed to it, or are involved in it. To change your notification preferences, please click here: http://projects.puppetlabs.com/my/account -- You received this message because you are subscribed to the Google Groups Puppet Bugs group. To post to this group, send email to puppet-bugs@googlegroups.com. To unsubscribe from this group, send email to puppet-bugs+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/puppet-bugs?hl=en.
[Puppet - Feature #16426] Publish API documentation automatically
Issue #16426 has been updated by Nigel Kersten. We've had intro chats with Mashery and Apigee (who are Puppet users...) about their services as far as publishing APIs go. Happy to set up conversations if anyone involved in this is interested. There are some nice benefits to a more interactive set of API docs that can be awesome for development. Feature #16426: Publish API documentation automatically https://projects.puppetlabs.com/issues/16426#change-71149 Author: Andrew Parker Status: Unreviewed Priority: Normal Assignee: Category: API Target version: Affected Puppet version: Keywords: documentation, docs, yard, API Branch: At the moment there is no generated documentation that we automatically publish. This limits our ability to document and publish the public API for using puppet as a library or accessing supported features when writing extensions. There have been some attempts in the past to generate YARD docs and publish them to github as gh-pages, but that effort bit-rotted. We need to come up with a way of creating and maintaining these kinds of docs. -- You have received this notification because you have either subscribed to it, or are involved in it. To change your notification preferences, please click here: http://projects.puppetlabs.com/my/account -- You received this message because you are subscribed to the Google Groups Puppet Bugs group. To post to this group, send email to puppet-bugs@googlegroups.com. To unsubscribe from this group, send email to puppet-bugs+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/puppet-bugs?hl=en.
[Puppet - Feature #16426] Publish API documentation automatically
Issue #16426 has been updated by Justin Stoller. YARDoc-wise, is this what you guys are kinda looking for? http://rdoc.info/gems/puppet/frames Feature #16426: Publish API documentation automatically https://projects.puppetlabs.com/issues/16426#change-71150 Author: Andrew Parker Status: Unreviewed Priority: Normal Assignee: Category: API Target version: Affected Puppet version: Keywords: documentation, docs, yard, API Branch: At the moment there is no generated documentation that we automatically publish. This limits our ability to document and publish the public API for using puppet as a library or accessing supported features when writing extensions. There have been some attempts in the past to generate YARD docs and publish them to github as gh-pages, but that effort bit-rotted. We need to come up with a way of creating and maintaining these kinds of docs. -- You have received this notification because you have either subscribed to it, or are involved in it. To change your notification preferences, please click here: http://projects.puppetlabs.com/my/account -- You received this message because you are subscribed to the Google Groups Puppet Bugs group. To post to this group, send email to puppet-bugs@googlegroups.com. To unsubscribe from this group, send email to puppet-bugs+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/puppet-bugs?hl=en.
