[
https://issues.apache.org/jira/browse/TINKERPOP-1816?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16222413#comment-16222413
]
Florian Hockmann commented on TINKERPOP-1816:
---------------------------------------------
I just thought that we might translate the various Gremlin traversals in the
docs for the different languages which would basically require for .NET
"convert the first letter to upper-case", but I haven't looked much in how the
docs generation works to be honest. Also I don't suppose to do that right now.
It was just an idea for the long-term.
There are probably other things we can improve about the documentation first
and with less effort like merging those sections as you and [~jorgebg] already
suggested. I think that it would also make sense to break up the very long
reference docs into several pages for the different sections (like the docs for
JanusGraph are structured for example). Seeing this extremely long page might
simply scare off new users and it makes it a bit hard to find e.g. the
Gremlin.Net subsection as you have to scroll down a lot even in the navigation
panel since it's below all the steps.
A very basic "getting started" page might also make sense that introduces the
Gremlin Server, the Console and the language with two or three basic traversals
and then points to other sections like the language specific sections and the
traversal steps.
> Consider improvements to the .NET documentation
> -----------------------------------------------
>
> Key: TINKERPOP-1816
> URL: https://issues.apache.org/jira/browse/TINKERPOP-1816
> Project: TinkerPop
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 3.2.6
> Reporter: Bill Woo
> Priority: Minor
>
> Without at least one complete code sample, you are wasting potential users;
> time.
> How do you run a query/traversal ?
> By "stumbling around in the dark" I was able to get this far:
> private Graph graph = new Graph();
> private GraphTraversalSource g;
> // in method body
> g = graph.Traversal().WithRemote(new DriverRemoteConnection(new
> GremlinClient(new GremlinServer("localhost", 8182))));
>
> Vertex v1 = new Vertex("Bill");
> g.AddV(v1);
> Vertex v2 = new Vertex("Julie");
> g.AddV(v2);
> Edge e1 = new Edge("e1", v1, "Knows", v2);
> g.AddE(e1);
> VertexProperty p1 = new VertexProperty("p1","BillProp",
> "TestProp", v1);
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
