JanusGraph / JanusGraph/janusgraph

Examples of gremlin statements in the guide and online require futher guidance for usage with the getting started guide's environment

Open
#1,029 0 comments 0 reactions 0 assignees View on GitHub
area/docs
Dominant language
Java
Stars
5.8k
Forks
1.2k
Avg merge
13h 53m
Merged PRs (30d)
6

Description

# User role

Evaluating user
# Trying to achieve

Attempting to follow the getting started guide that offers to help with evaluation so I can gain intuitions about what JanusGraph can do, how to interact with it usefully, and the costs of managing its infrastructure all of which I'm attempting to do in order to avoid excluding it as a useful tooling choice.
# Steps to reproduce

1. Complete the getting started guide at http://docs.janusgraph.org/latest/server.html#server-getting-started.
2. Attempt to define edge labels as described at http://docs.janusgraph.org/latest/schema.html
1. using the statements directly
2. prefixing each statement with :> as you have learned about from the getting started guide
3. Check industry information about Gremlin such as at Wikipedia to see that gremlin is used without :> at all.

# Expected outcome

I can easily copy and paste the examples from the schema guide to add an edge label.
I receive no warnings or errors with at least one of 2.1 or 2.2.
I am left wondering no more than how to examine my altered schema and test its behaviours and otherwise confident that an organisation's engineers can do this much at speed.

# Actual outcome

I cannot run the example statements in either mode. The guide doesn't help me to find industry documentation that leads me to a solution and the guide and industry documentation I found overall suggest that 2.1 should operate without errors or warnings. The guide appears to have been untested and I'm left wondering whether the tool can be used at speed by a large company's engineers.

Contributor guide

Open the contributing guide

Research direction

Start with the getting started guide at docs.janusgraph.org/latest/server.html#server-getting-started and the schema guide at docs.janusgraph.org/latest/schema.html. Reproduce the edge-label examples in the stated environment, both directly and with the :> prefix, and compare the results with the guide's expected usage. Done means the examples run successfully or the documentation clearly explains the required form and how to inspect the resulting schema.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
databases, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.