Skip to content

Commit a5da3ff

Browse files
committed
Link out to placeholder upgrade guide from changelog
1 parent 0d69eaa commit a5da3ff

File tree

5 files changed

+15
-3
lines changed

5 files changed

+15
-3
lines changed

docs/source/administrator/upgrading/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ or the [Discourse forum](https://discourse.jupyter.org/).
2222
:maxdepth: 1
2323
:caption: Major releases guides
2424
25+
upgrade-3-to-4
2526
upgrade-2-to-3
2627
upgrade-1-to-2
2728
```

docs/source/administrator/upgrading/upgrade-1-to-2.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
(upgrade-1-to-2)=
2+
13
# Major upgrade: 1.\* to 2.\*
24

35
Z2JH 2 contains several breaking changes, including some that affect the security of your deployment.

docs/source/administrator/upgrading/upgrade-2-to-3.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
(upgrade-2-to-3)=
2+
13
# Major upgrade: 2.\* to 3.\*
24

35
Z2JH 3 contains some small breaking changes.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
(upgrade-3-to-4)=
2+
3+
# Major upgrade: 3.\* to 4.\*
4+
5+
This is currently just a placeholder file for until we have written upgrade docs.

docs/source/changelog.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@ changes in pull requests], this list should be updated.
1616

1717
### 4.0.0-beta.1 - 2024-10-XX
1818

19-
TODO: provide summarizing paragraph here
20-
TODO: link to upgrade notes
21-
TODO: include notable dependency changes like in previous major release
19+
TODO: write a release summary here.
20+
21+
This changelog is just providing an overview of changes, so its meant to be
22+
complemented with the [major version upgrade documentation](upgrade-3-to-4) with
23+
practical advice on upgrading accounting for changes.
2224

2325
#### Breaking changes
2426

0 commit comments

Comments
 (0)