JanusGraph / JanusGraph/janusgraph

Add a dedicated getting started section

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

Description

We see a lot of people having problems to start with JanusGraph, so we have to improve our documentation.

Including:
* Install & Run JanusGraph
- With Docker
- With gremlin-server.sh
- With janusgraph.sh
* Working with JanusGraph
- Adding data
- Query data
- Basic schema management
* Basic Architecture (Storage Backend, Mixed Index Backend and JanusGraph)
* Select a backend
* Next steps (Production, Schema Managment, ...)

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the existing JanusGraph documentation and the issue's listed getting-started topics, including Docker, gremlin-server.sh, and janusgraph.sh. Done means a dedicated section covers installation, basic data and schema work, architecture, backend selection, and next steps.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.