You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tinkerpop.apache.org by Stephen Mallette <sp...@gmail.com> on 2015/10/29 16:16:18 UTC
Tutorials Documentation
I've added the infrastructure for the Tutorials Book. It's currently
committed to this branch:
https://github.com/apache/incubator-tinkerpop/tree/TINKERPOP3-923
I've added one tutorial so far: "Getting Started in Five Minutes":
http://tinkerpop.incubator.apache.org/docs/3.1.0-SNAPSHOT/tutorials.html
I just wanted to get a rough cut out there for early feedback and review.
I did something I don't normally do in my writing and used the word "you"
in it. I did that for a couple of reasons:
1. It's a bit more friendly/familiar and these are tutorials that are
designed to draw new folks in.
2. I think this style of writing is a bit easier to write in which is why a
lot of folks seem to gravitate toward it naturally - thus merging pull
requests from potential authors won't be all discouraging for folks (i.e.
we won't have to say "please re-write all your stuff without using "you").
Anyway, I think this "Five Minutes" piece needs a fair bit of work as it's
in these five minutes that we could either get someone or lose someone. I
fully expect revisions and will issue a PR when it gets a bit more
polished.
Re: Tutorials Documentation
Posted by Marko Rodriguez <ok...@gmail.com>.
Hi,
We could also have a "menu item" at the top of the homepage called "TinkerPop Tutorials" that just HMTL anchors down to the Tutorials section.
Marko.
http://markorodriguez.com
On Oct 29, 2015, at 10:26 AM, Marko Rodriguez <ok...@gmail.com> wrote:
> Hi,
>
> The index of tutorials would be on our homepage in the Tutorial section.
>
> http://tinkerpop.incubator.apache.org/
>
> Next to SQL2Gremlin by Kuppitz…
>
> Marko.
>
> http://markorodriguez.com
>
> On Oct 29, 2015, at 9:48 AM, Stephen Mallette <sp...@gmail.com> wrote:
>
>>> Your intro tutorial is SEVERELY LACKING comedy
>>
>> I hadn't gotten to image work yet - but i was kinda thinking an image of
>> gremlin with a big ridiculous watch (being that this is a "timed" tutorial)
>> on his arm, but your ideas are pretty awesome - haha. again - that's why
>> it's kinda purposefully boring at the moment as i wanted to boot around
>> some ideas.
>>
>>> Do we really want "Tutorial" book? I don't think so..?
>>
>> I don't know - I kinda thought of it as a book with chapters of tutorials
>> (easy for others to add in new chapters without having to touch the pom). I
>> suppose multiple books would encourage more variety and style. On the
>> other hand, if we don't have such a book then we'll have to maintain an
>> index of tutorials somewhere.......not sure where that would go atm. ???
>>
>>
>>
>> On Thu, Oct 29, 2015 at 11:36 AM, Marko Rodriguez <ok...@gmail.com>
>> wrote:
>>
>>> Hi,
>>>
>>> * All the books are going to look the same if we keep this pattern
>>> going.
>>> * Each book needs a title logo (Apache character with
>>> title of book).
>>> * Your intro tutorial is SEVERELY LACKING comedy. Gremlin standing
>>> there naked was funny circa 2008.
>>> * Colors, colors, colors!
>>> * Image pool reuse (static/images) is crucial, lets keep that
>>> going.
>>> * Do we really want "Tutorial" book? I don't think so..?
>>> * Each tutorial should be a book in and of itself as there
>>> will be many many things down this road….
>>> * However, perhaps you do the "X Minute Ab Workout
>>> Tutorial" which has the 3 5, 15, 30 minute tutorials in one book.
>>>
>>> ……..see, now we get some humor going. Ab workout!
>>>
>>>
>>> https://raw.githubusercontent.com/apache/incubator-tinkerpop/master/docs/static/images/gremlin-standing-strong.png
>>>
>>> Gremlin as your personal trainer. "Comon' you lazy sack of beans. I'm
>>> going to need you to repeat() out() 3 times! GO GO GO GO!"
>>>
>>> You can even include exercise Gremlin.
>>>
>>> https://raw.githubusercontent.com/apache/incubator-tinkerpop/master/docs/static/images/gremlin-exercise.png
>>>
>>> The 5/15/30 Minute Tutorials should be ONE book, but not the ONLY Tutorial
>>> book and it should be Gremlin as exercise trainer. I can give you a pic of
>>> him bench pressing, oh oh!! If you need a back of Gremlin with some perky
>>> butt cheeks, I'm on that too.
>>>
>>> Marko.
>>>
>>> http://markorodriguez.com
>>>
>>> On Oct 29, 2015, at 9:16 AM, Stephen Mallette <sp...@gmail.com>
>>> wrote:
>>>
>>>> I've added the infrastructure for the Tutorials Book. It's currently
>>>> committed to this branch:
>>>>
>>>> https://github.com/apache/incubator-tinkerpop/tree/TINKERPOP3-923
>>>>
>>>> I've added one tutorial so far: "Getting Started in Five Minutes":
>>>>
>>>> http://tinkerpop.incubator.apache.org/docs/3.1.0-SNAPSHOT/tutorials.html
>>>>
>>>> I just wanted to get a rough cut out there for early feedback and review.
>>>> I did something I don't normally do in my writing and used the word "you"
>>>> in it. I did that for a couple of reasons:
>>>>
>>>> 1. It's a bit more friendly/familiar and these are tutorials that are
>>>> designed to draw new folks in.
>>>> 2. I think this style of writing is a bit easier to write in which is
>>> why a
>>>> lot of folks seem to gravitate toward it naturally - thus merging pull
>>>> requests from potential authors won't be all discouraging for folks (i.e.
>>>> we won't have to say "please re-write all your stuff without using
>>> "you").
>>>>
>>>> Anyway, I think this "Five Minutes" piece needs a fair bit of work as
>>> it's
>>>> in these five minutes that we could either get someone or lose someone.
>>> I
>>>> fully expect revisions and will issue a PR when it gets a bit more
>>>> polished.
>>>
>>>
>
Re: Tutorials Documentation
Posted by Marko Rodriguez <ok...@gmail.com>.
Hi,
The index of tutorials would be on our homepage in the Tutorial section.
http://tinkerpop.incubator.apache.org/
Next to SQL2Gremlin by Kuppitz…
Marko.
http://markorodriguez.com
On Oct 29, 2015, at 9:48 AM, Stephen Mallette <sp...@gmail.com> wrote:
>> Your intro tutorial is SEVERELY LACKING comedy
>
> I hadn't gotten to image work yet - but i was kinda thinking an image of
> gremlin with a big ridiculous watch (being that this is a "timed" tutorial)
> on his arm, but your ideas are pretty awesome - haha. again - that's why
> it's kinda purposefully boring at the moment as i wanted to boot around
> some ideas.
>
>> Do we really want "Tutorial" book? I don't think so..?
>
> I don't know - I kinda thought of it as a book with chapters of tutorials
> (easy for others to add in new chapters without having to touch the pom). I
> suppose multiple books would encourage more variety and style. On the
> other hand, if we don't have such a book then we'll have to maintain an
> index of tutorials somewhere.......not sure where that would go atm. ???
>
>
>
> On Thu, Oct 29, 2015 at 11:36 AM, Marko Rodriguez <ok...@gmail.com>
> wrote:
>
>> Hi,
>>
>> * All the books are going to look the same if we keep this pattern
>> going.
>> * Each book needs a title logo (Apache character with
>> title of book).
>> * Your intro tutorial is SEVERELY LACKING comedy. Gremlin standing
>> there naked was funny circa 2008.
>> * Colors, colors, colors!
>> * Image pool reuse (static/images) is crucial, lets keep that
>> going.
>> * Do we really want "Tutorial" book? I don't think so..?
>> * Each tutorial should be a book in and of itself as there
>> will be many many things down this road….
>> * However, perhaps you do the "X Minute Ab Workout
>> Tutorial" which has the 3 5, 15, 30 minute tutorials in one book.
>>
>> ……..see, now we get some humor going. Ab workout!
>>
>>
>> https://raw.githubusercontent.com/apache/incubator-tinkerpop/master/docs/static/images/gremlin-standing-strong.png
>>
>> Gremlin as your personal trainer. "Comon' you lazy sack of beans. I'm
>> going to need you to repeat() out() 3 times! GO GO GO GO!"
>>
>> You can even include exercise Gremlin.
>>
>> https://raw.githubusercontent.com/apache/incubator-tinkerpop/master/docs/static/images/gremlin-exercise.png
>>
>> The 5/15/30 Minute Tutorials should be ONE book, but not the ONLY Tutorial
>> book and it should be Gremlin as exercise trainer. I can give you a pic of
>> him bench pressing, oh oh!! If you need a back of Gremlin with some perky
>> butt cheeks, I'm on that too.
>>
>> Marko.
>>
>> http://markorodriguez.com
>>
>> On Oct 29, 2015, at 9:16 AM, Stephen Mallette <sp...@gmail.com>
>> wrote:
>>
>>> I've added the infrastructure for the Tutorials Book. It's currently
>>> committed to this branch:
>>>
>>> https://github.com/apache/incubator-tinkerpop/tree/TINKERPOP3-923
>>>
>>> I've added one tutorial so far: "Getting Started in Five Minutes":
>>>
>>> http://tinkerpop.incubator.apache.org/docs/3.1.0-SNAPSHOT/tutorials.html
>>>
>>> I just wanted to get a rough cut out there for early feedback and review.
>>> I did something I don't normally do in my writing and used the word "you"
>>> in it. I did that for a couple of reasons:
>>>
>>> 1. It's a bit more friendly/familiar and these are tutorials that are
>>> designed to draw new folks in.
>>> 2. I think this style of writing is a bit easier to write in which is
>> why a
>>> lot of folks seem to gravitate toward it naturally - thus merging pull
>>> requests from potential authors won't be all discouraging for folks (i.e.
>>> we won't have to say "please re-write all your stuff without using
>> "you").
>>>
>>> Anyway, I think this "Five Minutes" piece needs a fair bit of work as
>> it's
>>> in these five minutes that we could either get someone or lose someone.
>> I
>>> fully expect revisions and will issue a PR when it gets a bit more
>>> polished.
>>
>>
Re: Tutorials Documentation
Posted by Stephen Mallette <sp...@gmail.com>.
> Your intro tutorial is SEVERELY LACKING comedy
I hadn't gotten to image work yet - but i was kinda thinking an image of
gremlin with a big ridiculous watch (being that this is a "timed" tutorial)
on his arm, but your ideas are pretty awesome - haha. again - that's why
it's kinda purposefully boring at the moment as i wanted to boot around
some ideas.
> Do we really want "Tutorial" book? I don't think so..?
I don't know - I kinda thought of it as a book with chapters of tutorials
(easy for others to add in new chapters without having to touch the pom). I
suppose multiple books would encourage more variety and style. On the
other hand, if we don't have such a book then we'll have to maintain an
index of tutorials somewhere.......not sure where that would go atm. ???
On Thu, Oct 29, 2015 at 11:36 AM, Marko Rodriguez <ok...@gmail.com>
wrote:
> Hi,
>
> * All the books are going to look the same if we keep this pattern
> going.
> * Each book needs a title logo (Apache character with
> title of book).
> * Your intro tutorial is SEVERELY LACKING comedy. Gremlin standing
> there naked was funny circa 2008.
> * Colors, colors, colors!
> * Image pool reuse (static/images) is crucial, lets keep that
> going.
> * Do we really want "Tutorial" book? I don't think so..?
> * Each tutorial should be a book in and of itself as there
> will be many many things down this road….
> * However, perhaps you do the "X Minute Ab Workout
> Tutorial" which has the 3 5, 15, 30 minute tutorials in one book.
>
> ……..see, now we get some humor going. Ab workout!
>
>
> https://raw.githubusercontent.com/apache/incubator-tinkerpop/master/docs/static/images/gremlin-standing-strong.png
>
> Gremlin as your personal trainer. "Comon' you lazy sack of beans. I'm
> going to need you to repeat() out() 3 times! GO GO GO GO!"
>
> You can even include exercise Gremlin.
>
> https://raw.githubusercontent.com/apache/incubator-tinkerpop/master/docs/static/images/gremlin-exercise.png
>
> The 5/15/30 Minute Tutorials should be ONE book, but not the ONLY Tutorial
> book and it should be Gremlin as exercise trainer. I can give you a pic of
> him bench pressing, oh oh!! If you need a back of Gremlin with some perky
> butt cheeks, I'm on that too.
>
> Marko.
>
> http://markorodriguez.com
>
> On Oct 29, 2015, at 9:16 AM, Stephen Mallette <sp...@gmail.com>
> wrote:
>
> > I've added the infrastructure for the Tutorials Book. It's currently
> > committed to this branch:
> >
> > https://github.com/apache/incubator-tinkerpop/tree/TINKERPOP3-923
> >
> > I've added one tutorial so far: "Getting Started in Five Minutes":
> >
> > http://tinkerpop.incubator.apache.org/docs/3.1.0-SNAPSHOT/tutorials.html
> >
> > I just wanted to get a rough cut out there for early feedback and review.
> > I did something I don't normally do in my writing and used the word "you"
> > in it. I did that for a couple of reasons:
> >
> > 1. It's a bit more friendly/familiar and these are tutorials that are
> > designed to draw new folks in.
> > 2. I think this style of writing is a bit easier to write in which is
> why a
> > lot of folks seem to gravitate toward it naturally - thus merging pull
> > requests from potential authors won't be all discouraging for folks (i.e.
> > we won't have to say "please re-write all your stuff without using
> "you").
> >
> > Anyway, I think this "Five Minutes" piece needs a fair bit of work as
> it's
> > in these five minutes that we could either get someone or lose someone.
> I
> > fully expect revisions and will issue a PR when it gets a bit more
> > polished.
>
>
Re: Tutorials Documentation
Posted by Marko Rodriguez <ok...@gmail.com>.
Hi,
* All the books are going to look the same if we keep this pattern going.
* Each book needs a title logo (Apache character with title of book).
* Your intro tutorial is SEVERELY LACKING comedy. Gremlin standing there naked was funny circa 2008.
* Colors, colors, colors!
* Image pool reuse (static/images) is crucial, lets keep that going.
* Do we really want "Tutorial" book? I don't think so..?
* Each tutorial should be a book in and of itself as there will be many many things down this road….
* However, perhaps you do the "X Minute Ab Workout Tutorial" which has the 3 5, 15, 30 minute tutorials in one book.
……..see, now we get some humor going. Ab workout!
https://raw.githubusercontent.com/apache/incubator-tinkerpop/master/docs/static/images/gremlin-standing-strong.png
Gremlin as your personal trainer. "Comon' you lazy sack of beans. I'm going to need you to repeat() out() 3 times! GO GO GO GO!"
You can even include exercise Gremlin.
https://raw.githubusercontent.com/apache/incubator-tinkerpop/master/docs/static/images/gremlin-exercise.png
The 5/15/30 Minute Tutorials should be ONE book, but not the ONLY Tutorial book and it should be Gremlin as exercise trainer. I can give you a pic of him bench pressing, oh oh!! If you need a back of Gremlin with some perky butt cheeks, I'm on that too.
Marko.
http://markorodriguez.com
On Oct 29, 2015, at 9:16 AM, Stephen Mallette <sp...@gmail.com> wrote:
> I've added the infrastructure for the Tutorials Book. It's currently
> committed to this branch:
>
> https://github.com/apache/incubator-tinkerpop/tree/TINKERPOP3-923
>
> I've added one tutorial so far: "Getting Started in Five Minutes":
>
> http://tinkerpop.incubator.apache.org/docs/3.1.0-SNAPSHOT/tutorials.html
>
> I just wanted to get a rough cut out there for early feedback and review.
> I did something I don't normally do in my writing and used the word "you"
> in it. I did that for a couple of reasons:
>
> 1. It's a bit more friendly/familiar and these are tutorials that are
> designed to draw new folks in.
> 2. I think this style of writing is a bit easier to write in which is why a
> lot of folks seem to gravitate toward it naturally - thus merging pull
> requests from potential authors won't be all discouraging for folks (i.e.
> we won't have to say "please re-write all your stuff without using "you").
>
> Anyway, I think this "Five Minutes" piece needs a fair bit of work as it's
> in these five minutes that we could either get someone or lose someone. I
> fully expect revisions and will issue a PR when it gets a bit more
> polished.
Re: Tutorials Documentation
Posted by pieter <pi...@gmail.com>.
+1
A gremlinfiddle site similar to https://jsfiddle.net/ would also be
great. Its a lot of work though.
Cheers
Pieter
On 29/10/2015 17:16, Stephen Mallette wrote:
> I've added the infrastructure for the Tutorials Book. It's currently
> committed to this branch:
>
> https://github.com/apache/incubator-tinkerpop/tree/TINKERPOP3-923
>
> I've added one tutorial so far: "Getting Started in Five Minutes":
>
> http://tinkerpop.incubator.apache.org/docs/3.1.0-SNAPSHOT/tutorials.html
>
> I just wanted to get a rough cut out there for early feedback and review.
> I did something I don't normally do in my writing and used the word "you"
> in it. I did that for a couple of reasons:
>
> 1. It's a bit more friendly/familiar and these are tutorials that are
> designed to draw new folks in.
> 2. I think this style of writing is a bit easier to write in which is why a
> lot of folks seem to gravitate toward it naturally - thus merging pull
> requests from potential authors won't be all discouraging for folks (i.e.
> we won't have to say "please re-write all your stuff without using "you").
>
> Anyway, I think this "Five Minutes" piece needs a fair bit of work as it's
> in these five minutes that we could either get someone or lose someone. I
> fully expect revisions and will issue a PR when it gets a bit more
> polished.
>