I happened to turn a splinter of an idea over the weekend into something
that was almost fully working only to find out that someone else had
already done the work better than me - oh well, the good news is that we
can now generate this kind of documentation:

https://imgur.com/a/bTdUO

I think that will be a big help to users who come from other languages
(with the rise of GLVs) and say...."ugh, it's all Groovy, where is the <my
language> stuff?" Unfortunately, I don't think they are making the
connection that it's all just Gremlin. Anyway, I think it would be neat if
we slowly started migrating the documentation toward something for GLV
centric and less so heavily focused on Java and this would be an easy good
start.

Note that ultimately, the goal here is to not dynamically eval() every
snippet of Gremlin in every language. I think we will have a "Console" tab
and a "Groovy" tab, followed by whatever tabs we add additional docs for.
The "Console" tab will be the Groovy Console output as we have now and the
other tabs will just have the raw code (without execution). That way, you
can look at the execution on the Console tab first then see the syntax in
your favorite language.

I've pushed the work so far to this branch

https://github.com/apache/tinkerpop/tree/TINKERPOP-1447

so that I can get a little help from Kuppitz with his pre-processor stuff
for the Console tab to generate properly. Anyway, thoughts welcome on
what's there so far.

Reply via email to