JanusGraph/janusgraph

Move upgrade instructions to a separate page

Open

#1815 aperta il 29 set 2019

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

Metriche repository

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

Descrizione

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.

Guida contributor

Direzione di ricerca
Crea una nuova pagina per le istruzioni di aggiornamento nel sito di documentazione, tipicamente sotto una sezione 'aggiornamento' o 'migrazione'. Quindi sposta il contenuto delle istruzioni di aggiornamento dalla pagina del Changelog alla nuova pagina e aggiorna eventuali riferimenti incrociati.
Tech stack
java
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
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.
80