JanusGraph/janusgraph

Move upgrade instructions to a separate page

Open

#1.815 geöffnet am 29. Sept. 2019

Auf GitHub ansehen
 (4 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Java (1.137 Forks)batch import
area/docshelp wantedkind/cleanup

Repository-Metriken

Stars
 (4.985 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 3T 18h) (12 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Erstelle eine neue Seite für Upgrade Anweisungen in der Dokumentationsseite, typischerweise unter einem Abschnitt 'Upgrade' oder 'Migration'. Verschiebe dann den Inhalt der Upgrade Anweisungen von der Changelog Seite auf die neue Seite und aktualisiere alle Querverweise.
Tech Stack
java
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitMarkdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80