JanusGraph/janusgraph

Add a dedicated getting started section

Open

#1.824 geöffnet am 6. Okt. 2019

Auf GitHub ansehen
 (3 Kommentare) (3 Reaktionen) (0 zugewiesene Personen)Java (1.137 Forks)batch import
area/docshelp wantedkind/enhancement

Repository-Metriken

Stars
 (4.985 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 3T 18h) (12 gemergte PRs in 30 T)

Beschreibung

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

Research-Richtung
Untersuchen Sie die vorhandene Dokumentationsstruktur im Repository, insbesondere das 'docs' Verzeichnis oder das Wiki. Sehen Sie sich an, wie andere Abschnitte wie Installationsanleitungen organisiert sind. Das Issue erwähnt Docker und Shell Skripte, stellen Sie also sicher, dass diese Beispiele enthalten sind. Überprüfen Sie die Kommentare zum Issue auf zusätzliche Anleitungen der Maintainer, bevor Sie den Abschnitt schreiben.
Tech Stack
java
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitMarkdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85