JanusGraph/janusgraph

Add a dedicated getting started section

Open

#1824 aperta il 6 ott 2019

Vedi su GitHub
 (3 commenti) (3 reazioni) (0 assegnatari)Java (1137 fork)batch import
area/docshelp wantedkind/enhancement

Metriche repository

Star
 (4985 star)
Metriche merge PR
 (Merge medio 3g 18h) (12 PR mergiate in 30 g)

Descrizione

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, ...)

Guida contributor

Direzione di ricerca
Esamina la struttura della documentazione esistente nel repository, in particolare la directory 'docs' o il wiki. Osserva come sono organizzate altre sezioni, come le guide di installazione. Il problema menziona Docker e script di shell, quindi assicurati di includere quegli esempi. Controlla i commenti sul problema per eventuali indicazioni aggiuntive dei manutentori prima di scrivere la sezione.
Tech stack
java
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitMarkdown
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85