Skip to content

Commit ff5296c

Browse files
authored
Renamed root level glv-examples to gremlin-examples for consistency. (#3261)
1 parent 7eaecf4 commit ff5296c

31 files changed

+19
-19
lines changed

CHANGELOG.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ image::https://raw.githubusercontent.com/apache/tinkerpop/master/docs/static/ima
2929
* Fixed edge properties for GraphBinary which were not deserializing properly.
3030
* Deprecated `has(key, traversal)` and `has(T, traversal)` options for `has()` step.
3131
* Improved GLV examples reliability and documentation with step-by-step instructions.
32-
* Added root-level GLV examples in `glv-examples/` directory that use published driver versions for easy out-of-the-box usage, separate from module-level examples that use local development code.
32+
* Added root-level GLV examples in `gremlin-examples/` directory that use published driver versions for easy out-of-the-box usage, separate from module-level examples that use local development code.
3333
* Bump netty to 4.1.125.Final
3434
3535
[[release-3-7-4]]

docs/src/dev/developer/development-environment.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -497,10 +497,10 @@ and GLVs will run automatically with integration tests against the TinkerTransac
497497
** Generate web site locally: `bin/generate-home.sh`
498498
** Publish web site: `bin/publish-home.sh <username>`
499499
500-
[[glv-examples]]
501-
== GLV Examples
500+
[[gremlin-examples]]
501+
== Gremlin Examples
502502
503-
TinkerPop maintains GLV examples in two distinct locations. User-facing examples in the `glv-examples/` directory
503+
TinkerPop maintains GLV examples in two distinct locations. User-facing examples in the `gremlin-examples/` directory
504504
utilize published driver versions and are referenced in the main documentation. Module-level examples within each GLV
505505
directory (e.g., `gremlin-python/src/main/python/examples/`) use local development code to ensure compatibility and
506506
prevent regressions.

docs/src/dev/developer/release.asciidoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -332,11 +332,11 @@ the help of a PMC member for those steps.
332332
. Ensure that the GLV examples compile and run with the latest image and dependencies: `bin/run-examples.sh`.
333333
.. Make changes as necessary to update the examples.
334334
. Update root-level GLV examples to use the new release version:
335-
.. Update version numbers in `glv-examples/gremlin-java/pom.xml` to reference the new release version
336-
.. Update version numbers in `glv-examples/gremlin-javascript/package.json` to reference the new release version
337-
.. Update version numbers in `glv-examples/gremlin-python/requirements.txt` to reference the new release version
338-
.. Update version numbers in `glv-examples/gremlin-dotnet/*/\*.csproj` to reference the new release version
339-
.. Update version numbers in `glv-examples/gremlin-go/go.mod` to reference the new release version
335+
.. Update version numbers in `gremlin-examples/gremlin-java/pom.xml` to reference the new release version
336+
.. Update version numbers in `gremlin-examples/gremlin-javascript/package.json` to reference the new release version
337+
.. Update version numbers in `gremlin-examples/gremlin-python/requirements.txt` to reference the new release version
338+
.. Update version numbers in `gremlin-examples/gremlin-dotnet/*/\*.csproj` to reference the new release version
339+
.. Update version numbers in `gremlin-examples/gremlin-go/go.mod` to reference the new release version
340340
.. Test that all root-level examples work correctly with the new published versions
341341
. Generate a list of dead branches that will be automatically deleted and post them as a DISCUSS thread for review, then once consensus is reached removed those branches.
342342
. Set up the IO tests for the current `SNAPSHOT` as discussed in the <<io,IO Documentation and Testing Section>>

docs/src/reference/gremlin-variants.asciidoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -521,7 +521,7 @@ that can be used to fulfill the `gremlingo.Set` interface if desired.
521521
=== Application Examples
522522
523523
The TinkerPop source code contains some sample applications that demonstrate the basics of Gremlin-Go. They
524-
can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/glv-examples/gremlin-go/[here]
524+
can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/gremlin-examples/gremlin-go/[here]
525525
and are designed to connect to a running <<gremlin-server,Gremlin Server>> configured with the
526526
`conf/gremlin-server.yaml` and `conf/gremlin-server-modern.yaml` files as included with the standard release packaging.
527527
@@ -559,7 +559,7 @@ Navigate to the examples directory:
559559
560560
[source,shell]
561561
----
562-
cd glv-examples/gremlin-go
562+
cd gremlin-examples/gremlin-go
563563
----
564564
565565
Run the examples:
@@ -1281,7 +1281,7 @@ execute it.
12811281
=== Application Examples
12821282
12831283
The TinkerPop source code contains some sample applications that demonstrate the basics of Gremlin-Java. They
1284-
can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/glv-examples/gremlin-java/[here]
1284+
can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/gremlin-examples/gremlin-java/[here]
12851285
and are designed to connect to a running <<gremlin-server,Gremlin Server>> configured with the
12861286
`conf/gremlin-server.yaml` and `conf/gremlin-server-modern.yaml` files as included with the standard release packaging.
12871287
@@ -1320,7 +1320,7 @@ Navigate to the examples directory:
13201320
13211321
[source,shell]
13221322
----
1323-
cd glv-examples/gremlin-java
1323+
cd gremlin-examples/gremlin-java
13241324
----
13251325
13261326
Build the examples with Maven:
@@ -1749,7 +1749,7 @@ no `Graph` instance to deserialize a result into on the client-side. A workaroun
17491749
=== Application Examples
17501750
17511751
The TinkerPop source code contains some sample applications that demonstrate the basics of Gremlin-JavaScript. They
1752-
can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/glv-examples/gremlin-javascript/[here]
1752+
can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/gremlin-examples/gremlin-javascript/[here]
17531753
and are designed to connect to a running <<gremlin-server,Gremlin Server>> configured with the
17541754
`conf/gremlin-server.yaml` and `conf/gremlin-server-modern.yaml` files as included with the standard release packaging.
17551755
@@ -1788,7 +1788,7 @@ Navigate to the examples directory:
17881788
17891789
[source,shell]
17901790
----
1791-
cd glv-examples/gremlin-javascript
1791+
cd gremlin-examples/gremlin-javascript
17921792
----
17931793
17941794
Install the dependencies:
@@ -2170,7 +2170,7 @@ dotnet new gremlin -o MyFirstGremlinProject
21702170
=== Application Examples
21712171
21722172
The TinkerPop source code contains some sample applications that demonstrate the basics of Gremlin-Dotnet. They
2173-
can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/glv-examples/gremlin-dotnet/[here]
2173+
can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/gremlin-examples/gremlin-dotnet/[here]
21742174
and are designed to connect to a running <<gremlin-server,Gremlin Server>> configured with the
21752175
`conf/gremlin-server.yaml` and `conf/gremlin-server-modern.yaml` files as included with the standard release packaging.
21762176
@@ -2208,7 +2208,7 @@ Navigate to the examples directory:
22082208
22092209
[source,shell]
22102210
----
2211-
cd glv-examples/gremlin-dotnet
2211+
cd gremlin-examples/gremlin-dotnet
22122212
----
22132213
22142214
Build all projects:
@@ -2767,7 +2767,7 @@ async def run_in_thread():
27672767
=== Application Examples
27682768
27692769
The TinkerPop source code contains some sample applications that demonstrate the basics of Gremlin-Python. They
2770-
can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/glv-examples/gremlin-python/[here]
2770+
can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/gremlin-examples/gremlin-python/[here]
27712771
and are designed to connect to a running <<gremlin-server,Gremlin Server>> configured with the
27722772
`conf/gremlin-server.yaml` and `conf/gremlin-server-modern.yaml` files as included with the standard release packaging.
27732773
@@ -2808,7 +2808,7 @@ Navigate to the examples directory:
28082808
28092809
[source,shell]
28102810
----
2811-
cd glv-examples/gremlin-python
2811+
cd gremlin-examples/gremlin-python
28122812
----
28132813
28142814
Install the requirements:
File renamed without changes.

0 commit comments

Comments
 (0)