JanusGraph/janusgraph

Add a dedicated getting started section

Open

#1 824 ouverte le 6 oct. 2019

Voir sur GitHub
 (3 commentaires) (3 réactions) (0 assignés)Java (1 137 forks)batch import
area/docshelp wantedkind/enhancement

Métriques du dépôt

Stars
 (4 985 stars)
Métriques de merge PR
 (Merge moyen 3j 18h) (12 PRs mergées en 30 j)

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

Guide contributeur

Direction de recherche
Examinez la structure de documentation existante dans le dépôt, en particulier le répertoire 'docs' ou le wiki. Regardez comment d'autres sections, comme les guides d'installation, sont organisées. Le problème mentionne Docker et les scripts shell, assurez vous donc d'inclure ces exemples. Vérifiez les commentaires sur le problème pour toute directive supplémentaire des mainteneurs avant d'écrire la section.
Stack technique
java
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitMarkdown
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85