This looks like a good approach to me. I like that it follows the previous convention and includes the annotated code samples. I think the "how to submit a recipe" is a good idea.
--Ted On Tue, May 3, 2016 at 3:06 PM, Stephen Mallette <spmalle...@gmail.com> wrote: > I set up the basic framework for the "Recipes" documentation that we've > been long talking about. I chose to go with a more detailed approach to > recipes than I had with GremlinDocs as I think it is more fitting of what > the TinkerPop documentation style is these days. The recipes use our > standard doc generation processes so nothing new there. Here's what it > looks like so far: > > http://tinkerpop.apache.org/docs/3.2.1-SNAPSHOT/recipes/ > > and the branch with the changes in it: > > https://github.com/apache/incubator-tinkerpop/tree/TINKERPOP-1286 > > I have dozens of recipes to add to the two simple ones I started with, but > I thought I would let everyone see what I had so far to make sure this > format is good. I would think that over time we might see "groupings" of > recipes starting to form - similar to the old Gang of Four style (e.g. > creational patterns, structural patterns, etc.). That might help us better > keep our list of recipes organized in the long run - for now - not a big > deal. > > Anyway, if no one has any serious problems, I'll issue the PR with just my > two recipes, that way others can jump in and collaborate. I'm thinking we > might add a section to an appendix of this document about "How to submit a > recipe" because I'm not so sure that everyone realizes how our docs work. >
