JanusGraph/janusgraph

Add a dedicated getting started section

Open

#1,824 opened on Oct 6, 2019

View on GitHub
 (3 comments) (3 reactions) (0 assignees)Java (4,985 stars) (1,137 forks)batch import
area/docshelp wantedkind/enhancement

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

Tech stack
javadockershell
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic understanding of JanusGraphfamiliarity with command line
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Examine the existing documentation structure in the repository, particularly the 'docs' directory or wiki. Look at how other sections like installation guides are organized. The issue mentions Docker and shell scripts, so ensure those examples are included. Check the comments on the issue for any additional maintainer guidance before writing the section.
Add a dedicated getting started section · JanusGraph/janusgraph#1824 | Good First Issue