JanusGraph/janusgraph

Add a dedicated getting started section

Open

#1.824 aberto em 6 de out. de 2019

Ver no GitHub
 (3 comments) (3 reactions) (0 assignees)Java (1.137 forks)batch import
area/docshelp wantedkind/enhancement

Métricas do repositório

Stars
 (4.985 stars)
Métricas de merge de PR
 (Mesclagem média 3d 18h) (12 fundiu PRs em 30d)

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

Guia do colaborador

Direção de pesquisa
Examine a estrutura de documentação existente no repositório, particularmente o diretório 'docs' ou o wiki. Veja como outras seções, como guias de instalação, estão organizadas. O problema menciona Docker e scripts de shell, portanto, certifique se de incluir esses exemplos. Verifique os comentários do problema para obter qualquer orientação adicional dos mantenedores antes de escrever a seção.
Pilha de tecnologia
java
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitMarkdown
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85