This is an automated email from the ASF dual-hosted git repository.
spmallette pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git
The following commit(s) were added to refs/heads/master by this push:
new d1949573e5 Clean up upgrade documentation structural inconsistencies
CTR
d1949573e5 is described below
commit d1949573e54d6f0698805ed67893a34dd9c9cb45
Author: Stephen Mallette <[email protected]>
AuthorDate: Fri Jun 26 11:23:55 2026 +0000
Clean up upgrade documentation structural inconsistencies CTR
- Fix heading-level jump in release-4.x.x (===== to ==== for
Declarative Pattern Matching).
- Restructure 4.0.0-beta.1 Providers section: move
Renaming NoneStep to DiscardStep and Changes to Serialization under
==== Graph System Providers as ===== subsections.
- Fix release-3.6.5 changelog anchor to use dashes (release-3-6-5).
- Wrap 3.6.6 Providers content in ==== Graph Driver Providers.
- Add missing blank lines after == TinkerPop 3.5.8 and 3.7.1 headings.
- Reorder 3.2.6 stanza so the changelog paragraph precedes
=== Upgrading for Users.
- Remove doubled 'Release Date:' prefix in 3.2.0.
- Fold variant provider category names into the canonical pair
Graph System Providers / Graph Driver Providers across 3.3.x
and 3.4.x; merge duplicate Graph System Providers section in 3.3.0.
---
docs/src/upgrade/release-3.2.x-incubating.asciidoc | 7 +++----
docs/src/upgrade/release-3.3.x.asciidoc | 12 +++++-------
docs/src/upgrade/release-3.4.x.asciidoc | 4 ++--
docs/src/upgrade/release-3.5.x.asciidoc | 1 +
docs/src/upgrade/release-3.6.x.asciidoc | 4 +++-
docs/src/upgrade/release-3.7.x.asciidoc | 1 +
docs/src/upgrade/release-4.x.x.asciidoc | 11 ++++++-----
7 files changed, 21 insertions(+), 19 deletions(-)
diff --git a/docs/src/upgrade/release-3.2.x-incubating.asciidoc
b/docs/src/upgrade/release-3.2.x-incubating.asciidoc
index 32a6119182..18ef7d7448 100644
--- a/docs/src/upgrade/release-3.2.x-incubating.asciidoc
+++ b/docs/src/upgrade/release-3.2.x-incubating.asciidoc
@@ -435,13 +435,12 @@ See:
link:https://issues.apache.org/jira/browse/TINKERPOP-1821[TINKERPOP-1821]
== TinkerPop 3.2.6
-
*Release Date: August 21, 2017*
-=== Upgrading for Users
-
Please see the
link:https://github.com/apache/tinkerpop/blob/3.2.6/CHANGELOG.asciidoc#release-3-2-6[changelog]
for a complete list of all the modifications that are part of this release.
+=== Upgrading for Users
+
==== Deprecated useMapperFromGraph
The `userMapperFromGraph` configuration option for the Gremlin Server
serializers has been deprecated. Change
@@ -1459,7 +1458,7 @@ to take arguments for the `Traversal` to be constructed
by extending classes.
== TinkerPop 3.2.0
-*Release Date: Release Date: April 8, 2016*
+*Release Date: April 8, 2016*
Please see the
link:https://github.com/apache/tinkerpop/blob/3.2.0-incubating/CHANGELOG.asciidoc#tinkerpop-320-release-date-april-8-2016[changelog]
for a complete list of all the modifications that are part of this release.
diff --git a/docs/src/upgrade/release-3.3.x.asciidoc
b/docs/src/upgrade/release-3.3.x.asciidoc
index ea862ef553..75ba0c6b1b 100644
--- a/docs/src/upgrade/release-3.3.x.asciidoc
+++ b/docs/src/upgrade/release-3.3.x.asciidoc
@@ -67,7 +67,7 @@ See:
link:https://issues.apache.org/jira/browse/TINKERPOP-2336[TINKERPOP-2336]
=== Upgrading for Providers
-==== Gremlin Driver Providers
+==== Graph Driver Providers
===== Session Close
@@ -357,7 +357,7 @@ See:
link:https://issues.apache.org/jira/browse/TINKERPOP-2182[TINKERPOP-2182]
=== Upgrading for Providers
-==== Graph Database Providers
+==== Graph System Providers
===== Detection of Anti-Patterns
@@ -490,7 +490,7 @@ for the least amount of data necessary to continue the
traversal evaluation.
=== Upgrading for Providers
-==== Graph Database Providers
+==== Graph System Providers
===== OptOut on GraphProvider
@@ -733,7 +733,7 @@ In particular, these properties referenced in TinkerPop
documentation and config
IMPORTANT: It is recommended that providers also review all the upgrade
instructions specified for users. Many of the
changes there may prove important for the provider's implementation.
-==== Graph Database Providers
+==== Graph System Providers
===== IO Version Check
@@ -1215,8 +1215,6 @@ Under the new model, the plugin simply returns
`Customizer` instances that can b
`ScriptEngine` or specifically to a particular `ScriptEngine`. More details
can be found in the
link:https://tinkerpop.apache.org/docs/x.y.z/dev/provider/#gremlin-plugins[Provider
Documentation]
-==== Graph Database Providers
-
===== Test Suite Removal
A number of test suites that were previously deprecated have been removed
which should reduce the burden on graph
@@ -1247,7 +1245,7 @@ to transaction problems and it allows for more common,
generalized error handlin
See: link:https://issues.apache.org/jira/browse/TINKERPOP-1004[TINKERPOP-1004]
-==== Driver Providers
+==== Graph Driver Providers
===== SASL Byte Array
diff --git a/docs/src/upgrade/release-3.4.x.asciidoc
b/docs/src/upgrade/release-3.4.x.asciidoc
index 4e8c09a4a0..04666a910d 100644
--- a/docs/src/upgrade/release-3.4.x.asciidoc
+++ b/docs/src/upgrade/release-3.4.x.asciidoc
@@ -945,7 +945,7 @@
link:https://tinkerpop.apache.org/docs/3.4.1/reference/#sparql-with-gremlin[Refe
=== Upgrading for Providers
-==== Graph Database Providers
+==== Graph System Providers
===== GraphBinary Serializer Changes
@@ -1657,7 +1657,7 @@ See:
link:https://issues.apache.org/jira/browse/TINKERPOP-2037[TINKERPOP-2037]
=== Upgrading for Providers
-==== Graph Database Providers
+==== Graph System Providers
===== io() Step
diff --git a/docs/src/upgrade/release-3.5.x.asciidoc
b/docs/src/upgrade/release-3.5.x.asciidoc
index fd5a4f5d55..fa96dd9173 100644
--- a/docs/src/upgrade/release-3.5.x.asciidoc
+++ b/docs/src/upgrade/release-3.5.x.asciidoc
@@ -24,6 +24,7 @@ image::gremlin-sleeping-beauty.png[width=225]
*The Sleeping Gremlin: No. 18 Entr'acte Symphonique*
== TinkerPop 3.5.8
+
*Release Date: November 20, 2023*
Please see the
link:https://github.com/apache/tinkerpop/blob/3.5.8/CHANGELOG.asciidoc#release-3-5-8[changelog]
for a
diff --git a/docs/src/upgrade/release-3.6.x.asciidoc
b/docs/src/upgrade/release-3.6.x.asciidoc
index 0b48f5b5b5..f406acc4b4 100644
--- a/docs/src/upgrade/release-3.6.x.asciidoc
+++ b/docs/src/upgrade/release-3.6.x.asciidoc
@@ -74,6 +74,8 @@ complete list of all the modifications that are part of this
release.
=== Upgrading for Providers
+==== Graph Driver Providers
+
The `HttpGremlinRequestEncoder` constructor has been deprecated in favor of
one with an additional parameter
`boolean userAgentEnabled`. User agent HTTP headers can now be encoded if this
flag is enabled.
@@ -81,7 +83,7 @@ The `HttpGremlinRequestEncoder` constructor has been
deprecated in favor of one
*Release Date: July 31, 2023*
-Please see the
link:https://github.com/apache/tinkerpop/blob/3.6.5/CHANGELOG.asciidoc#release-3.6.5[changelog]
for a
+Please see the
link:https://github.com/apache/tinkerpop/blob/3.6.5/CHANGELOG.asciidoc#release-3-6-5[changelog]
for a
complete list of all the modifications that are part of this release.
=== Upgrading for Users
diff --git a/docs/src/upgrade/release-3.7.x.asciidoc
b/docs/src/upgrade/release-3.7.x.asciidoc
index 0d7e175746..a8ebe96e8a 100644
--- a/docs/src/upgrade/release-3.7.x.asciidoc
+++ b/docs/src/upgrade/release-3.7.x.asciidoc
@@ -380,6 +380,7 @@ Please see the
link:https://github.com/apache/tinkerpop/blob/3.7.2/CHANGELOG.asc
complete list of all the modifications that are part of this release.
== TinkerPop 3.7.1
+
*Release Date: November 20, 2023*
Please see the
link:https://github.com/apache/tinkerpop/blob/3.7.1/CHANGELOG.asciidoc#release-3-7-1[changelog]
for a
diff --git a/docs/src/upgrade/release-4.x.x.asciidoc
b/docs/src/upgrade/release-4.x.x.asciidoc
index 163404417f..176f68c116 100644
--- a/docs/src/upgrade/release-4.x.x.asciidoc
+++ b/docs/src/upgrade/release-4.x.x.asciidoc
@@ -32,7 +32,7 @@ complete list of all the modifications that are part of this
release.
=== Upgrading for Users
-===== Declarative Pattern Matching
+==== Declarative Pattern Matching
Gremlin has always offered both imperative and declarative styles to writing
graph queries. While the imperative style
has largely dominated examples and usages, the `match` step has always
provided a declarative way to express queries.
@@ -1572,12 +1572,15 @@ required.
=== Upgrading for Providers
-==== Renaming NoneStep to DiscardStep
+==== Graph System Providers
+
+===== Renaming NoneStep to DiscardStep
+
NoneStep, which was primarily used by `iterate()` to discard traversal results
in remote contexts, has been renamed to
DiscardStep. In its place is a new list filtering NoneStep, which takes a
predicate as an argument and passes lists with
no elements matching the predicate.
-==== Changes to Serialization
+===== Changes to Serialization
The V4 versions of GraphBinary and GraphSON are being introduced. Support for
the older versions of GraphBinary (V1)
and GraphSON (V1-3) is removed. Upon the full release of 4.0, the GLVs will
only use GraphBinary, however, the Gremlin
@@ -1637,8 +1640,6 @@ The `GraphSONSerializerProvider` is not used in GraphSON
4. The `GraphSONSeriali
intended to serialize specific types and not used as a general serializer,
GraphSON 4 serializers will throw an error
when encountering unknown types.
-==== Graph System Providers
-
===== AbstractAuthenticatorHandler Constructor
The deprecated one-arg constructor for `AbstractAuthenticationHandler` has
been removed along with two-arg constructors