Hello,
First off Stephen, this is a beautiful tutorial. Well done. Nice graphics too
:D.
Here is a list of comments for you to do with as you please:
* Its called "The Gremlin Console" but the URL is advanced-console. I
would renamed the file to the-gremlin-console.
* "The First Five Minutes" link is bad.
* "reference documentation" link is bad.
* "features of the Gremlin Console, through a number " … no comma
needed between Console and through.
* "The following points summarize the key features discussed in each of
the use cases:" should read "The following points summarize the key features of
each use case:"
* I would have an IMPORTANT saying why graph and g are different right
after your first code snippet.
* createTheCrew needs to be createTheCrew().
* Lots of bad URLs in the "A Learning Tool" section. Check them all out.
* Note that "reference documentation" is now nested in the directory
structure of our docs :| … thus, all such links are bad.
* I would add an IMPORTANT about import static
org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.__.*;
* "it iterates the entries() " should be "it iterates the entrySet()".
* "It is possible to prevent auto-iteration" doesn't need to be a new
paragraph.
* g.V().has('name', name).drop(); --- your Java examples need " not ' …
i.e. "name" (there are a couple of these)
* The first reference to Cassandra should say "Apache Cassandra" and
URL link to it.
* When you mention "firstYear" you should say something like "note that
we use next() to get the value and save it to the variable."
* Your code examples have some extreme indenting here and there. Might
want to tighten that up.
* I would not use sideEffect{} in your last example. Instead use
forEachRemaining{ }… This way there is no "it" to explain and its more natural
as it both iterates() (is terminal) and you don't need the ;null.
Man…what an epic piece of work. You must feel good about yourself.
Take care,
Marko.
http://markorodriguez.com
On Jan 25, 2016, at 6:06 PM, Stephen Mallette <[email protected]> wrote:
> To keep with the pattern of having at least one new tutorial with every
> release, I wrote a fresh tutorial about the Gremlin Console. It seeks to
> address the kinds of questions we repeatedly get over and over again while
> providing some common use cases. It will be nice to reply to folks with
> links to parts of this tutorial rather than having to type the same answers
> over and over again. I took the same approach as the last tutorial and
> sought a familiar style with copious use of the word "you" - a style of
> writing I sorta struggle with, but again, i think that style is good for
> the "tutorial" pattern.
>
> http://tinkerpop.apache.org/docs/3.1.1-SNAPSHOT/tutorials/advanced-console/
>
> Anyway, please feel free to provide some feedback so that I can get this
> guy finalized in time for 3.1.1-incubating next week.
