JanusGraph / JanusGraph/janusgraph

Adopt Basic Usage chapter for Docker image

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

The _Getting Started_ part of the docs starts with a chapter _Installation_ where using the Docker image is the preferred method to set up JanusGraph, but in the following _Basic Usage_ chapter the assumption is that JanusGraph is used locally from the distribution archive. It makes heavy use of `JanusGraphFactory.open()`.

We should either rework this chapter to be better compatible with the Docker image where we have JanusGraph Server running and only connect to that, or at least clearly state the fact this chapter only works with the local installation method.

The current situation is confusing to users as can be seen for example in [this question](https://github.com/JanusGraph/janusgraph-docker/discussions/133).

Contributor guide

Open the contributing guide

Research direction

Start with the Getting Started, Installation, and Basic Usage chapters, focusing on the examples that use JanusGraphFactory.open(). Compare their assumptions with the Docker image's JanusGraph Server workflow. Done means the chapter either works for Docker-based usage or clearly identifies its local distribution-archive requirement and avoids confusing users.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, java
Domain
databases, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.