JanusGraph / JanusGraph/janusgraph

Getting started guide doesn't say what to do if the guide doesn't work

Open
#1,028 3 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

Reproduce any of the problems reported by me to this issue tracker in the 24 hours up until the time of this issue.
Check the guide at http://docs.janusgraph.org/latest/server.html#server-getting-started for advice of what issues I might experience and what to do about it

# Expected outcome

I find advice on what some of the things that can reasonably happen during evaluation mean, what action to take, and how to figure out whether and when I will complete my evaluation.

The advice on actions to take includes instructions and templates to report the ideal bug, asks me to reproduce the issue while a diagnostic mode is enabled and tells me how to enable, disable and check whether it's enabled, etc.

# Actual outcome

There's no advice in the guide. The guide assumes success is assured.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the server getting-started guide at docs.janusgraph.org/latest/server.html#server-getting-started and the problems referenced in this issue's recent reports. Done means the guide explains likely evaluation failures, diagnostic-mode steps, completion checks, and how to report an ideal bug with a reproducible template.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.