JanusGraph/janusgraph

Move upgrade instructions to a separate page

Open

#1 815 ouverte le 29 sept. 2019

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

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

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.

Guide contributeur

Direction de recherche
Créez une nouvelle page pour les instructions de mise à niveau sur le site de documentation, généralement sous une section 'mise à niveau' ou 'migration'. Ensuite, déplacez le contenu des instructions de mise à niveau de la page Changelog vers la nouvelle page et mettez à jour toutes les références croisées.
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.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
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.
80