JanusGraph/janusgraph

Move upgrade instructions to a separate page

Open

#1.815 aberto em 29 de set. de 2019

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

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

Currently upgrade instructions are listed in Changelog but it isn't right because of the following facts:

  • Upgrade instructions in most cases should upgrade from feature versions and not bugfix versions. We have currently 6 upgrade instructions: from Titan to JanusGraph 0.1.x, from 0.1.x to 0.2.x, from 0.2.0 to 0.2.1 (exceptional case), from 0.2.x to 0.3.x, from 0.3.x to 0.4.x, from 0.4.x to 0.5.x.
  • Currently upgrade instructions are hard to be find because you should go to Changelog and find the fist version of a specific feature version to which you would like to upgrade. It isn't intuitively as for me.

I would like to propose to move all upgrade instructions to a separate page.

Guia do colaborador

Direção de pesquisa
Crie uma nova página para instruções de atualização no site de documentação, geralmente sob uma seção 'upgrade' ou 'migration'. Em seguida, mova o conteúdo das instruções de atualização da página de Changelog para a nova página e atualize quaisquer referências cruzadas.
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.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
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.
80