JanusGraph/janusgraph

Move upgrade instructions to a separate page

Open

#1,815 opened on Sep 29, 2019

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Java (4,985 stars) (1,137 forks)batch import
area/docshelp wantedkind/cleanup

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.

Contributor guide

Tech stack
java
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The current upgrade instructions are embedded in the Changelog markdown files. The issue proposes moving them to a separate page. First time contributors should locate the changelog file(s) in the docs/ directory (e.g., CHANGELOG.md) and identify all upgrade instruction blocks. Then, create a new page like UPGRADE.md and link it from the documentation sidebar. Review the existing comments on the issue for any additional suggestions or concerns.