Skip to content

Commit

Permalink
Polish upgrade pages
Browse files Browse the repository at this point in the history
  • Loading branch information
stefano-ottolenghi committed Nov 21, 2024
1 parent 166ed47 commit 4c3b7c9
Show file tree
Hide file tree
Showing 9 changed files with 13 additions and 40 deletions.
5 changes: 1 addition & 4 deletions common-content/modules/ROOT/partials/upgrade.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
# tag::intro[]

This page contains the list of new features and breaking changes of the driver from version 4.4 to 5.x. +
This page contains the list of new features and breaking changes of the driver from version 4.4 to 5.x.
For a full list of changes, see the link:{driver-changelog-url}[Driver -> Changelog].

[NOTE]
This page may be revised with new changes up until when the latest 5.x version is released.

The link:https://github.com/neo4j/drivers-migration-assistent[Neo4j Drivers Migration Assistent] simplifies the upgrade process by contextualizing the changelog to your application.
It scans your codebase for usage of deprecations and removals, and brings them up to you.
The tool doesn't automatically rewrite your code; it only points at where action is needed, providing in-context information on how each hit should be addressed.
Expand Down
5 changes: 1 addition & 4 deletions dotnet-manual/modules/ROOT/pages/upgrade.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,9 @@

= Upgrade from older versions

This page contains the list of new features and breaking changes of the driver from version 4.4 to 5.x. +
This page contains the list of new features and breaking changes of the driver from version 4.4 to 5.x.
For a full list of changes, see the link:{driver-changelog-url}[Driver -> Changelog].

[NOTE]
This page may be revised with new changes up until when the latest 5.x version is released.

The latest driver version of the 5.x series (5.27) is compatible with Neo4j server both 4.4 and 5.x, so you can upgrade the driver before you upgrade the server.
At the same time, the driver version 4.4 is forward compatible with Neo4j server 5.x, so you could also upgrade the server before the driver; however, given that it's easier to roll back an application upgrade than a server upgrade, it's recommended to start with the driver.

Expand Down
1 change: 1 addition & 0 deletions go-manual/modules/ROOT/pages/connect-advanced.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ driver, err := neo4j.NewDriverWithContext(dbUri, neo4j.NoAuth())
----


[#rotating-tokens]
[role=label--new-5.14]
== Rotating authentication tokens

Expand Down
21 changes: 3 additions & 18 deletions go-manual/modules/ROOT/pages/upgrade.adoc
Original file line number Diff line number Diff line change
@@ -1,23 +1,8 @@
= Upgrade from older versions

This page contains the list of new features and breaking changes that happened in the driver from version 4.4 to 5.x.
For a full list of changes, see the link:https://github.com/neo4j/neo4j-go-driver/wiki/5.x-changelog[Driver -> Changelog].

The link:https://github.com/neo4j/drivers-migration-assistant[Neo4j Drivers Migration Assistant] simplifies the upgrade process, by contextualizing the changelog to your codebase.
It scans your codebase for usage of deprecations and removals, and brings them up to you.
The tool doesn't automatically rewrite your code; it only points at where action is needed, providing in-context information on how each hit should be addressed.
:driver-changelog-url: https://github.com/neo4j/neo4j-go-driver/wiki/5.x-changelog

The migration assistant requires `python3`.

Any of the 5.x versions of the driver is compatible both with Neo4j server 4.4 and 5.x, so you can upgrade the driver before you upgrade the server.
The driver version 4.4 is forward compatible with Neo4j server 5.x as well, so you could also upgrade the server before the driver; however, given that it's easier to roll back an application upgrade than a server upgrade, it's recommended to start with the driver.

[TIP]
When upgrading the Neo4j server to a newer version, the Cypher queries in your application may also need updating. +
See link:https://neo4j.com/docs/cypher-manual/current/deprecations-additions-removals-compatibility/[Cypher -> Deprecations, additions, and compatibility].
= Upgrade from older versions

[NOTE]
If migrating from earlier than version 4.x, see the link:https://github.com/neo4j/neo4j-go-driver/blob/v4.0.0-beta1/MIGRATIONGUIDE.md[migration guide to version 4] first.
include::{common-partial}/upgrade.adoc[tag=intro]


[[recommended-steps]]
Expand Down
1 change: 1 addition & 0 deletions java-manual/modules/ROOT/pages/connect-advanced.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ GraphDatabase.driver(dbUri, AuthTokens.custom(principal, credentials, realm, sch
If authentication is disabled on the server, the authentication parameter can be omitted entirely.


[#rotating-tokens]
[role=label--new-5.18]
== Rotating authentication tokens

Expand Down
2 changes: 1 addition & 1 deletion java-manual/modules/ROOT/pages/upgrade.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

= Upgrade from older versions

This page contains the list of new features and breaking changes of the driver from version 4.4 to 5.x. +
This page contains the list of new features and breaking changes of the driver from version 4.4 to 5.x.
For a full list of changes, see the link:{driver-changelog-url}[Driver -> Changelog].

The latest driver version of the 5.x series (5.27) is compatible with Neo4j server both 4.4 and 5.x, so you can upgrade the driver before you upgrade the server.
Expand Down
1 change: 1 addition & 0 deletions javascript-manual/modules/ROOT/pages/connect-advanced.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ const driver = neo4j.driver(
If authentication is disabled on the server, the authentication parameter can be omitted entirely.


[#rotating-tokens]
[role=label--new-5.14]
== Rotating authentication tokens

Expand Down
1 change: 1 addition & 0 deletions python-manual/modules/ROOT/pages/connect-advanced.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ Use the function link:{neo4j-docs-base-uri}/api/python-driver/current/api.html#n
If authentication is disabled on the server, the authentication parameter can be omitted entirely.


[#rotating-tokens]
[role=label--new-5.14]
== Rotating authentication tokens

Expand Down
16 changes: 3 additions & 13 deletions python-manual/modules/ROOT/pages/upgrade.adoc
Original file line number Diff line number Diff line change
@@ -1,18 +1,8 @@
= Upgrade from older versions

This page contains the list of new features and breaking changes that happened in the driver from version 4.4 to 5.x. +
For a full list of changes, see the link:https://github.com/neo4j/neo4j-python-driver/wiki/5.x-changelog[Driver -> Changelog].
:driver-changelog-url: https://github.com/neo4j/neo4j-python-driver/wiki/5.x-changelog

The link:https://github.com/neo4j/drivers-migration-assistant[Neo4j Drivers Migration Assistant] simplifies the upgrade process, by contextualizing the changelog to your codebase.
It scans your codebase for usage of deprecations and removals, and brings them up to you.
The tool doesn't automatically rewrite your code; it only points at where action is needed, providing in-context information on how each hit should be addressed.

Any of the 5.x versions of the driver is compatible both with Neo4j server 4.4 and 5.x, so you can upgrade the driver before you upgrade the server.
The driver version 4.4 is forward compatible with Neo4j server 5.x as well, so you could also upgrade the server before the driver; however, given that it's easier to roll back an application upgrade than a server upgrade, it's recommended to start with the driver.
= Upgrade from older versions

[TIP]
When upgrading the Neo4j server to a newer version, the Cypher queries in your application may also need updating. +
See link:https://neo4j.com/docs/cypher-manual/current/deprecations-additions-removals-compatibility/[Cypher -> Deprecations, additions, and compatibility].
include::{common-partial}/upgrade.adoc[tag=intro]


[[recommended-steps]]
Expand Down

0 comments on commit 4c3b7c9

Please sign in to comment.