cockroachdb / cockroachdb/docs

Need upgrade path doc

Open
#7,433 3 comments 0 reactions 1 assignee Claimed by @taroface View on GitHub
C-doc-improvement no-issue-activity P-3 T-missing-info
Dominant language
HTML
Stars
212
Forks
476
Avg merge
40m
Merged PRs (30d)
3

Description

Bram Gruneir (BramGruneir) commented:

We're missing a clear and concise doc that's explicit on exactly which versions need to be walked through to upgrade.

Our mixing of major and minor version numbers is already confusing for just about everyone, so lacking this doc makes it worse.

I'm thinking something along the lines of:

```
2.0.x -> 2.1.x
2.1.x -> 19.1.x
19.1.x -> 19.2.x
19.2.x -> 20.1.x
20.1.x -> 20.2.x
```

With some language about:

- what we consider a major version
- how we don't have minor versions
- how patch versions can be applied
- how we must upgrade through each major version
- when can you downgrade (put a previous patch version on)
- how we finalize the version (and downgrades cannot happen afterwards)
- and how to prevent the finalization step if needed, but a warning about not doing so
- maybe a note about our release cadence and numbering because it's confusing.

Jira Issue: DOC-524

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.