[GIE Doc] Add Tutorials for Gremlin Users #2369
Conversation
|
You can check the doc preview at https://alibaba-graphscope-build-pr-2369.surge.sh/ |
docs/index.rst
Outdated
| @@ -244,6 +244,7 @@ each of which can be independently scaled to chase for the best end-to-end throu | |||
| cpp_tutorials | |||
| walkthrough_examples_acrossing_engines | |||
| video_tutorials | |||
| gremlin_tutorials | |||
There was a problem hiding this comment.
Can be place under cpp tutorials.
docs/gremlin_tutorials.md
Outdated
| # Tutorials for Gremlin Users | ||
|
|
||
| ## Introduction | ||
| This documentation guides you how to work with the gremlin graph traversal language in GraphScope. On the one hand we retain the original syntax of most steps from the standard gremlin, on the other hand the usages of some steps are further extended to denote more complex situations in real-world scenarios. |
There was a problem hiding this comment.
Maybe insert a link to the official gremlin guide somewhere?
docs/gremlin_tutorials.md
Outdated
|
|
||
| ## Introduction | ||
| This documentation guides you how to work with the gremlin graph traversal language in GraphScope. On the one hand we retain the original syntax of most steps from the standard gremlin, on the other hand the usages of some steps are further extended to denote more complex situations in real-world scenarios. | ||
|
|
There was a problem hiding this comment.
Since this file is very long, It would be better if we could add an index here.
e.g.,
- Supported Steps
- Limitations
and link them to corresponding sections.
docs/gremlin_tutorials.md
Outdated
|
|
||
| Parameters: </br> | ||
| * predicate - the predicate containing another tag to apply. | ||
| ```bash |
There was a problem hiding this comment.
Please check the code in the preview link.
It is too long to display in a page.
Maybe following our style guide to wrap at 80 chars is an option.
Or please wrap it manually to make it graceful in a page :)
docs/gremlin_tutorials.md
Outdated
| ``` | ||
| * startKey - the tag containing the object to filter, </br> predicate - the predicate containing another tag to apply. | ||
| ```bash | ||
| g.V().as("a").out().out().as("b").where("b", P.eq("a")) # is the entry referred by `b` equal to the entry referred by `a`? |
There was a problem hiding this comment.
ditto, and check the following codes.
docs/gremlin_tutorials.md
Outdated
| ## Limitations | ||
| Here we list steps which are unsupported yet. Some will be supported in the near future while others will remain unsupported for some reasons. | ||
|
|
||
| ### Todo |
docs/gremlin_tutorials.md
Outdated
| g.V().fold().count(local) | ||
| g.V().values('age').fold().sum(local) | ||
| ``` | ||
| ### Others |
There was a problem hiding this comment.
Others -> Unsupported
maybe more cleare?
docs/index.rst
Outdated
| @@ -40,6 +40,7 @@ and the vineyard store that offers efficient in-memory data transfers. | |||
| python_tutorials | |||
| java_tutorials | |||
| cpp_tutorials | |||
| gremlin_tutorials | |||
There was a problem hiding this comment.
Actually, I don't think this file is like a tutorial:
A tutorial is more like a step-by-step guide and wrapped up as a story/process.
For example, if there will be a gremlin_tutorial here,
I would expect it covers these sections:
- a brief introduction to Gremlin;
- Launch the GAIA;
- loading a graph data (maybe a drawing visualizing the graph)
- supported gremlin-client, how to connect the server;
- connected, several gremlin queries as examples, full steps please refer to THIS file
conclusively, it maybe more like
The First Five Minutes or The Next Fifteen Minutes in the official doc.
This file is more like an indexing page listing all available/unavailable steps.
Thus, I suggest rename this file as "Supported Gremlin Steps" and put it under ADVANCED TOPICS as below:
- dive into engines (which will expand to each engine, as below)
- analytical engine... (To appear)
- GAIA: interactive engine (To appear)
- Supported Gremlin Steps
How do you think?
|
😭 Deploy PR Preview bb80bbc failed. Build logs
🤖 By surge-preview |
What do these changes do?
as titled.
Related issue number
Fixes