You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by "kirill-stepanishin (via GitHub)" <gi...@apache.org> on 2025/09/19 23:01:22 UTC
[PR] Improve GLV examples reliability and documentation [tinkerpop]
kirill-stepanishin opened a new pull request, #3213:
URL: https://github.com/apache/tinkerpop/pull/3213
This PR improves the reliability and developer experience of Gremlin Language Variant (GLV) examples across all supported languages.
## Issues Fixed
- Go WriteBufferSize=0 causing E1201 buffer errors and nil pointer crashes
- Node.js v22+ WebSocket API incompatibility
- Python dependency conflicts preventing example builds
- Improved documentation for running examples
## Changes Made
- Fix WriteBufferSize=0 validation in Go gorillaTransporter
- Add conditional WebSocket .on() method usage for Node.js compatibility
- Resolve dependency conflicts in Python examples
- Add comprehensive documentation with prerequisites and build steps
- Configure all examples to consistently use local development code
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "andreachild (via GitHub)" <gi...@apache.org>.
andreachild commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2370083894
##########
docs/src/reference/gremlin-variants.asciidoc:
##########
@@ -525,27 +525,42 @@ can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/greml
and are designed to connect to a running <<gremlin-server,Gremlin Server>> configured with the
`conf/gremlin-server.yaml` and `conf/gremlin-server-modern.yaml` files as included with the standard release packaging.
-To run the examples, first download an image of Gremlin Server from Docker Hub:
+There are two ways to run Gremlin Server for these examples:
+
+- *Running locally* – see the <<gremlin-server,Gremlin Server>> documentation.
+- *Running with Docker*:
+
Review Comment:
Since this guide assumes Docker will be used, suggest to restructure as such:
```suggestion
This guide assumes Gremlin Server will be executed using Docker. Alternatively, Gremlin Server can run locally (see the <<gremlin-server,Gremlin Server>> documentation for this option).
To start Gremlin Server using Docker, first download an image of Gremlin Server from Docker Hub:
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "kirill-stepanishin (via GitHub)" <gi...@apache.org>.
kirill-stepanishin commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2371377957
##########
gremlin-go/examples/go.mod:
##########
@@ -21,9 +21,11 @@ go 1.24
require github.com/apache/tinkerpop/gremlin-go/v3 v3.7.3
+replace github.com/apache/tinkerpop/gremlin-go/v3 => ../
Review Comment:
Makes the examples use local source code instead of published packages for immediate feedback and to apply fixes instantly. Broader strategy regarding examples is in discussion.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "kirill-stepanishin (via GitHub)" <gi...@apache.org>.
kirill-stepanishin commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2371327626
##########
docs/src/reference/gremlin-variants.asciidoc:
##########
@@ -525,27 +525,42 @@ can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/greml
and are designed to connect to a running <<gremlin-server,Gremlin Server>> configured with the
`conf/gremlin-server.yaml` and `conf/gremlin-server-modern.yaml` files as included with the standard release packaging.
-To run the examples, first download an image of Gremlin Server from Docker Hub:
+There are two ways to run Gremlin Server for these examples:
+
+- *Running locally* – see the <<gremlin-server,Gremlin Server>> documentation.
+- *Running with Docker*:
+
Review Comment:
Applied this suggestion, thanks!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "kirill-stepanishin (via GitHub)" <gi...@apache.org>.
kirill-stepanishin commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2371330685
##########
gremlin-javascript/src/main/javascript/gremlin-javascript/lib/driver/connection.js:
##########
@@ -163,7 +163,13 @@ class Connection extends EventEmitter {
this._ws.addEventListener('open', this.#handleOpen);
this._ws.addEventListener('error', this.#handleError);
- this._ws.on('unexpected-response', this.#handleUnexpectedResponse);
+ // Only attach unexpected-response listener for Node.js WebSocket (ws package)
+ // Browser WebSocket does not have this event and .on() method
+ if (!useGlobalWebSocket) {
Review Comment:
Applied, thank you
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "andreachild (via GitHub)" <gi...@apache.org>.
andreachild commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2370407627
##########
gremlin-javascript/src/main/javascript/gremlin-javascript/lib/driver/connection.js:
##########
@@ -163,7 +163,13 @@ class Connection extends EventEmitter {
this._ws.addEventListener('open', this.#handleOpen);
this._ws.addEventListener('error', this.#handleError);
- this._ws.on('unexpected-response', this.#handleUnexpectedResponse);
+ // Only attach unexpected-response listener for Node.js WebSocket (ws package)
+ // Browser WebSocket does not have this event and .on() method
+ if (!useGlobalWebSocket) {
Review Comment:
Can the check be changed to be consistent with the`off` condition?
```suggestion
if (this._ws && 'on' in this._ws) {
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "andreachild (via GitHub)" <gi...@apache.org>.
andreachild commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2370019422
##########
docs/src/reference/gremlin-variants.asciidoc:
##########
@@ -525,27 +525,42 @@ can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/greml
and are designed to connect to a running <<gremlin-server,Gremlin Server>> configured with the
`conf/gremlin-server.yaml` and `conf/gremlin-server-modern.yaml` files as included with the standard release packaging.
-To run the examples, first download an image of Gremlin Server from Docker Hub:
+There are two ways to run Gremlin Server for these examples:
+
+- *Running locally* – see the <<gremlin-server,Gremlin Server>> documentation.
+- *Running with Docker*:
+
[source,shell]
----
docker pull tinkerpop/gremlin-server
----
-The remote connection and basic Gremlin examples can be run on a clean server, which uses the default configuration file
Review Comment:
Was this wording incorrect? Curious why it was removed.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "kirill-stepanishin (via GitHub)" <gi...@apache.org>.
kirill-stepanishin commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2371322494
##########
gremlin-dotnet/Examples/BasicGremlin/BasicGremlin.csproj:
##########
@@ -25,6 +25,6 @@ limitations under the License.
</PropertyGroup>
<ItemGroup>
- <PackageReference Include="Gremlin.Net" Version="3.7.0" />
+ <PackageReference Include="Gremlin.Net" Version="3.7.4" />
Review Comment:
Fixed in 44abbe0. Thank you!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "vkagamlyk (via GitHub)" <gi...@apache.org>.
vkagamlyk commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2366311688
##########
gremlin-go/examples/go.mod:
##########
@@ -21,9 +21,11 @@ go 1.24
require github.com/apache/tinkerpop/gremlin-go/v3 v3.7.3
+replace github.com/apache/tinkerpop/gremlin-go/v3 => ../
Review Comment:
Why is this necessary?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "andreachild (via GitHub)" <gi...@apache.org>.
andreachild commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2370083894
##########
docs/src/reference/gremlin-variants.asciidoc:
##########
@@ -525,27 +525,42 @@ can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/greml
and are designed to connect to a running <<gremlin-server,Gremlin Server>> configured with the
`conf/gremlin-server.yaml` and `conf/gremlin-server-modern.yaml` files as included with the standard release packaging.
-To run the examples, first download an image of Gremlin Server from Docker Hub:
+There are two ways to run Gremlin Server for these examples:
+
+- *Running locally* – see the <<gremlin-server,Gremlin Server>> documentation.
+- *Running with Docker*:
+
Review Comment:
Since this guide assumes Docker will be used, suggest to restructure as such (same suggestion for all GLV sections):
```suggestion
This guide assumes Gremlin Server will be executed using Docker. Alternatively, Gremlin Server can run locally (see the <<gremlin-server,Gremlin Server>> documentation for this option).
To start Gremlin Server using Docker, first download an image of Gremlin Server from Docker Hub:
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "kirill-stepanishin (via GitHub)" <gi...@apache.org>.
kirill-stepanishin commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2383264349
##########
docs/src/reference/gremlin-variants.asciidoc:
##########
@@ -525,27 +525,43 @@ can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/greml
and are designed to connect to a running <<gremlin-server,Gremlin Server>> configured with the
`conf/gremlin-server.yaml` and `conf/gremlin-server-modern.yaml` files as included with the standard release packaging.
-To run the examples, first download an image of Gremlin Server from Docker Hub:
+This guide assumes Gremlin Server will be executed using Docker. Alternatively, Gremlin Server can run locally (see the <<gremlin-server,Gremlin Server>> documentation for this option).
+
+To start Gremlin Server using Docker, first download an image of Gremlin Server from Docker Hub:
+
[source,shell]
----
docker pull tinkerpop/gremlin-server
----
-The remote connection and basic Gremlin examples can be run on a clean server, which uses the default configuration file
-`conf/gremlin-server.yaml`. To start a clean server, launch a new container with `docker run`:
+Clean server:
+
[source,shell]
----
docker run -d -p 8182:8182 tinkerpop/gremlin-server
----
-The traversal examples should be run on a server configured to start with the Modern toy graph, using `conf/gremlin-server-modern.yaml`.
-To start a server with the Modern graph preloaded, launch a new container with `docker run`:
+Modern toy graph server:
+
[source,shell]
----
docker run -d -p 8182:8182 tinkerpop/gremlin-server conf/gremlin-server-modern.yaml
----
-Each example can now be run with the following commands:
+The remote connection and basic Gremlin examples can be run on a clean server, while traversal examples should be run on a server with the Modern graph preloaded.
Review Comment:
applied in a follow-up PR (https://github.com/apache/tinkerpop/pull/3218). Thank you!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "andreachild (via GitHub)" <gi...@apache.org>.
andreachild commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2370130283
##########
docs/src/reference/gremlin-variants.asciidoc:
##########
@@ -1263,19 +1278,60 @@ execute it.
=== Application Examples
The TinkerPop source code contains some sample applications that demonstrate the basics of Gremlin-Java. They
-can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/gremlin-driver/src/main/java/examples/[here].
+can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/gremlin-driver/src/main/java/examples/[here]
+and are designed to connect to a running <<gremlin-server,Gremlin Server>> configured with the
+`conf/gremlin-server.yaml` and `conf/gremlin-server-modern.yaml` files as included with the standard release packaging.
+
+There are two ways to run Gremlin Server for these examples:
-The remote connection examples in particular are designed to connect to a running <<gremlin-server,Gremlin Server>>
-configured with the `conf/gremlin-server.yaml` file as included with the standard release packaging.
+- *Running locally* – see the <<gremlin-server,Gremlin Server>> documentation.
+- *Running with Docker*:
-To do so, download an image of Gremlin Server from Docker Hub, then launch a new container with `docker run`:
[source,shell]
----
docker pull tinkerpop/gremlin-server
+----
+
+Clean server:
+
+[source,shell]
+----
docker run -d -p 8182:8182 tinkerpop/gremlin-server
----
-All examples can then be run using your IDE of choice.
+Modern toy graph server:
+
+[source,shell]
+----
+docker run -d -p 8182:8182 tinkerpop/gremlin-server conf/gremlin-server-modern.yaml
+----
+
+==== Prerequisites
+- Java 11 (JDK) installed
Review Comment:
Same suggestion for all GLV sections:
```suggestion
- Compatible JDK installed (see <<development-environment,Development Environment>> for supported versions
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "kirill-stepanishin (via GitHub)" <gi...@apache.org>.
kirill-stepanishin commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2383266256
##########
gremlin-dotnet/Examples/Connections/Connections.csproj:
##########
@@ -25,6 +25,6 @@ limitations under the License.
</PropertyGroup>
<ItemGroup>
- <PackageReference Include="Gremlin.Net" Version="3.7.0" />
+ <ProjectReference Include="../../src/Gremlin.Net/Gremlin.Net.csproj" />
Review Comment:
Addressed in a follow-up PR https://github.com/apache/tinkerpop/pull/3218
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "codecov-commenter (via GitHub)" <gi...@apache.org>.
codecov-commenter commented on PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#issuecomment-3314158360
## [Codecov](https://app.codecov.io/gh/apache/tinkerpop/pull/3213?dropdown=coverage&src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) Report
:white_check_mark: All modified and coverable lines are covered by tests.
:white_check_mark: Project coverage is 74.24%. Comparing base ([`9b46b67`](https://app.codecov.io/gh/apache/tinkerpop/commit/9b46b6777d2fa250e41daacf2fa4554605aff53a?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)) to head ([`00e9955`](https://app.codecov.io/gh/apache/tinkerpop/commit/00e9955110ecfba9f0a0c4667e7d01c07872fb3d?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)).
:warning: Report is 378 commits behind head on 3.7-dev.
<details><summary>Additional details and impacted files</summary>
```diff
@@ Coverage Diff @@
## 3.7-dev #3213 +/- ##
=============================================
- Coverage 76.14% 74.24% -1.91%
=============================================
Files 1084 28 -1056
Lines 65160 5917 -59243
Branches 7285 0 -7285
=============================================
- Hits 49616 4393 -45223
+ Misses 12839 1322 -11517
+ Partials 2705 202 -2503
```
</details>
[:umbrella: View full report in Codecov by Sentry](https://app.codecov.io/gh/apache/tinkerpop/pull/3213?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
:loudspeaker: Have feedback on the report? [Share it here](https://about.codecov.io/codecov-pr-comment-feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
<details><summary> :rocket: New features to boost your workflow: </summary>
- :snowflake: [Test Analytics](https://docs.codecov.com/docs/test-analytics): Detect flaky tests, report on failures, and find test suite problems.
- :package: [JS Bundle Analysis](https://docs.codecov.com/docs/javascript-bundle-analysis): Save yourself from yourself by tracking and limiting bundle sizes in JS merges.
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "kirill-stepanishin (via GitHub)" <gi...@apache.org>.
kirill-stepanishin commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2371321799
##########
docs/src/reference/gremlin-variants.asciidoc:
##########
@@ -1687,37 +1743,54 @@ no `Graph` instance to deserialize a result into on the client-side. A workaroun
=== Application Examples
The TinkerPop source code contains some sample applications that demonstrate the basics of Gremlin-JavaScript. They
-can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/gremlin-javascript/examples/[here]
+can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/gremlin-javascript/examples/node/[here]
and are designed to connect to a running <<gremlin-server,Gremlin Server>> configured with the
`conf/gremlin-server.yaml` and `conf/gremlin-server-modern.yaml` files as included with the standard release packaging.
-To run the examples, first download an image of Gremlin Server from Docker Hub:
+There are two ways to run Gremlin Server for these examples:
+
+- *Running locally* – see the <<gremlin-server,Gremlin Server>> documentation.
+- *Running with Docker*:
+
[source,shell]
----
docker pull tinkerpop/gremlin-server
----
-The remote connection and basic Gremlin examples can be run on a clean server, which uses the default configuration file
-`conf/gremlin-server.yaml`. To start a clean server, launch a new container with `docker run`:
+Clean server:
+
[source,shell]
----
docker run -d -p 8182:8182 tinkerpop/gremlin-server
----
-The traversal examples should be run on a server configured to start with the Modern toy graph, using `conf/gremlin-server-modern.yaml`.
-To start a server with the Modern graph preloaded, launch a new container with `docker run`:
+Modern toy graph server:
+
[source,shell]
----
docker run -d -p 8182:8182 tinkerpop/gremlin-server conf/gremlin-server-modern.yaml
----
-Make sure to install all necessary packages:
+==== Prerequisites
+- Node.js v20 installed
Review Comment:
Replaced specific versions with a link to development environment documentation in 44abbe0
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "kirill-stepanishin (via GitHub)" <gi...@apache.org>.
kirill-stepanishin commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2371330137
##########
docs/src/reference/gremlin-variants.asciidoc:
##########
@@ -2092,29 +2165,54 @@ can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/greml
and are designed to connect to a running <<gremlin-server,Gremlin Server>> configured with the
`conf/gremlin-server.yaml` and `conf/gremlin-server-modern.yaml` files as included with the standard release packaging.
-To run the examples, first download an image of Gremlin Server from Docker Hub:
+There are two ways to run Gremlin Server for these examples:
+
+- *Running locally* – see the <<gremlin-server,Gremlin Server>> documentation.
+- *Running with Docker*:
+
[source,shell]
----
docker pull tinkerpop/gremlin-server
----
-The remote connection and basic Gremlin examples can be run on a clean server, which uses the default configuration file
-`conf/gremlin-server.yaml`. To start a clean server, launch a new container with `docker run`:
+Clean server:
+
[source,shell]
----
docker run -d -p 8182:8182 tinkerpop/gremlin-server
----
-The traversal examples should be run on a server configured to start with the Modern toy graph, using `conf/gremlin-server-modern.yaml`.
-To start a server with the Modern graph preloaded, launch a new container with `docker run`:
+Modern toy graph server:
+
[source,shell]
----
docker run -d -p 8182:8182 tinkerpop/gremlin-server conf/gremlin-server-modern.yaml
----
-Each example can now be run with the following command in their respective project directories:
+==== Prerequisites
+- .NET 8 SDK installed
+
+Navigate to the examples directory:
+
+[source,shell]
+----
+cd gremlin-dotnet/Examples
+----
+
+For each example project, navigate to its folder, then build and run:
Review Comment:
It works, applied this simplification to the instructions. Thank you
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "andreachild (via GitHub)" <gi...@apache.org>.
andreachild commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2370181630
##########
gremlin-dotnet/Examples/BasicGremlin/BasicGremlin.csproj:
##########
@@ -25,6 +25,6 @@ limitations under the License.
</PropertyGroup>
<ItemGroup>
- <PackageReference Include="Gremlin.Net" Version="3.7.0" />
+ <PackageReference Include="Gremlin.Net" Version="3.7.4" />
Review Comment:
This is not really a nit, inconsistency should be addressed.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "kirill-stepanishin (via GitHub)" <gi...@apache.org>.
kirill-stepanishin commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2371371656
##########
gremlin-dotnet/Examples/Connections/Connections.csproj:
##########
@@ -25,6 +25,6 @@ limitations under the License.
</PropertyGroup>
<ItemGroup>
- <PackageReference Include="Gremlin.Net" Version="3.7.0" />
+ <ProjectReference Include="../../src/Gremlin.Net/Gremlin.Net.csproj" />
Review Comment:
Thanks for the feedback! This is part of an ongoing discussion, will update based on the outcome.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "Cole-Greer (via GitHub)" <gi...@apache.org>.
Cole-Greer commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2369432190
##########
gremlin-python/src/main/python/setup.py:
##########
@@ -35,7 +35,7 @@
fd.write("'''")
fd.write(__doc__)
fd.write("'''\n")
- fd.write('version = %r\n' % os.getenv('VERSION', '?').replace('-SNAPSHOT', '.dev-%d' % timestamp))
+ fd.write('version = %r\n' % os.getenv('VERSION', '999.999.999.dev0').replace('-SNAPSHOT', '.dev-%d' % timestamp))
Review Comment:
Was this change necessary to get the python example running against the local dev build? It might be worth looking at how the[ Maven Replacer plugin is currently used](https://github.com/apache/tinkerpop/blob/e39d795177c6d05deb1a463c2d7a2124d4fa56c7/gremlin-python/pom.xml#L70-L82) to inject the gremlin version into [useragent.py](https://github.com/apache/tinkerpop/blob/e39d795177c6d05deb1a463c2d7a2124d4fa56c7/gremlin-python/src/main/python/gremlin_python/driver/useragent.py#L21). Perhaps that approach can be adapted to inject the correct version here.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "andreachild (via GitHub)" <gi...@apache.org>.
andreachild commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2369986433
##########
gremlin-dotnet/Examples/Connections/Connections.csproj:
##########
@@ -25,6 +25,6 @@ limitations under the License.
</PropertyGroup>
<ItemGroup>
- <PackageReference Include="Gremlin.Net" Version="3.7.0" />
+ <ProjectReference Include="../../src/Gremlin.Net/Gremlin.Net.csproj" />
Review Comment:
@vkagamlyk we were thinking of the examples in each GLV module to be executed as part of the build so that future breakages do not happen again (the examples are currently broken). The thought is to create a project level 'examples' folder which contains examples targeting latest released version which will not be executed as part of the build.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "andreachild (via GitHub)" <gi...@apache.org>.
andreachild commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2370130283
##########
docs/src/reference/gremlin-variants.asciidoc:
##########
@@ -1263,19 +1278,60 @@ execute it.
=== Application Examples
The TinkerPop source code contains some sample applications that demonstrate the basics of Gremlin-Java. They
-can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/gremlin-driver/src/main/java/examples/[here].
+can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/gremlin-driver/src/main/java/examples/[here]
+and are designed to connect to a running <<gremlin-server,Gremlin Server>> configured with the
+`conf/gremlin-server.yaml` and `conf/gremlin-server-modern.yaml` files as included with the standard release packaging.
+
+There are two ways to run Gremlin Server for these examples:
-The remote connection examples in particular are designed to connect to a running <<gremlin-server,Gremlin Server>>
-configured with the `conf/gremlin-server.yaml` file as included with the standard release packaging.
+- *Running locally* – see the <<gremlin-server,Gremlin Server>> documentation.
+- *Running with Docker*:
-To do so, download an image of Gremlin Server from Docker Hub, then launch a new container with `docker run`:
[source,shell]
----
docker pull tinkerpop/gremlin-server
+----
+
+Clean server:
+
+[source,shell]
+----
docker run -d -p 8182:8182 tinkerpop/gremlin-server
----
-All examples can then be run using your IDE of choice.
+Modern toy graph server:
+
+[source,shell]
+----
+docker run -d -p 8182:8182 tinkerpop/gremlin-server conf/gremlin-server-modern.yaml
+----
+
+==== Prerequisites
+- Java 11 (JDK) installed
Review Comment:
```suggestion
- Compatible JDK installed (see <<development-environment,environment>> for supported versions
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "kirill-stepanishin (via GitHub)" <gi...@apache.org>.
kirill-stepanishin closed pull request #3213: Improve GLV examples reliability and documentation
URL: https://github.com/apache/tinkerpop/pull/3213
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "vkagamlyk (via GitHub)" <gi...@apache.org>.
vkagamlyk commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2370094325
##########
gremlin-dotnet/Examples/Connections/Connections.csproj:
##########
@@ -25,6 +25,6 @@ limitations under the License.
</PropertyGroup>
<ItemGroup>
- <PackageReference Include="Gremlin.Net" Version="3.7.0" />
+ <ProjectReference Include="../../src/Gremlin.Net/Gremlin.Net.csproj" />
Review Comment:
Replacing `PackageReference` with `ProjectReference` will make the examples less useful because they won't run without loading and building driver source code.
To build examples with different driver versions, solution is to add 2 `.csproj` files with different setting.
Also compare with other .net examples.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "Cole-Greer (via GitHub)" <gi...@apache.org>.
Cole-Greer commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2369385419
##########
docs/src/reference/gremlin-variants.asciidoc:
##########
@@ -1687,37 +1743,54 @@ no `Graph` instance to deserialize a result into on the client-side. A workaroun
=== Application Examples
The TinkerPop source code contains some sample applications that demonstrate the basics of Gremlin-JavaScript. They
-can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/gremlin-javascript/examples/[here]
+can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/gremlin-javascript/examples/node/[here]
and are designed to connect to a running <<gremlin-server,Gremlin Server>> configured with the
`conf/gremlin-server.yaml` and `conf/gremlin-server-modern.yaml` files as included with the standard release packaging.
-To run the examples, first download an image of Gremlin Server from Docker Hub:
+There are two ways to run Gremlin Server for these examples:
+
+- *Running locally* – see the <<gremlin-server,Gremlin Server>> documentation.
+- *Running with Docker*:
+
[source,shell]
----
docker pull tinkerpop/gremlin-server
----
-The remote connection and basic Gremlin examples can be run on a clean server, which uses the default configuration file
-`conf/gremlin-server.yaml`. To start a clean server, launch a new container with `docker run`:
+Clean server:
+
[source,shell]
----
docker run -d -p 8182:8182 tinkerpop/gremlin-server
----
-The traversal examples should be run on a server configured to start with the Modern toy graph, using `conf/gremlin-server-modern.yaml`.
-To start a server with the Modern graph preloaded, launch a new container with `docker run`:
+Modern toy graph server:
+
[source,shell]
----
docker run -d -p 8182:8182 tinkerpop/gremlin-server conf/gremlin-server-modern.yaml
----
-Make sure to install all necessary packages:
+==== Prerequisites
+- Node.js v20 installed
Review Comment:
Nit: Should this be node 22 now?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "andreachild (via GitHub)" <gi...@apache.org>.
andreachild commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2370398107
##########
gremlin-dotnet/Examples/Connections/Connections.csproj:
##########
@@ -25,6 +25,6 @@ limitations under the License.
</PropertyGroup>
<ItemGroup>
- <PackageReference Include="Gremlin.Net" Version="3.7.0" />
+ <ProjectReference Include="../../src/Gremlin.Net/Gremlin.Net.csproj" />
Review Comment:
As an alternative to multiple `csproj` files how about single file with optional build property for example `dotnet build -p:UseLatestRelease` where default for `UseLatestRelease` is `true` but when running the examples as part of the build the value is set to `false`.
Or opposite scenario like `dotnet build -p:UseLocalReference` for example.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "andreachild (via GitHub)" <gi...@apache.org>.
andreachild commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2369986433
##########
gremlin-dotnet/Examples/Connections/Connections.csproj:
##########
@@ -25,6 +25,6 @@ limitations under the License.
</PropertyGroup>
<ItemGroup>
- <PackageReference Include="Gremlin.Net" Version="3.7.0" />
+ <ProjectReference Include="../../src/Gremlin.Net/Gremlin.Net.csproj" />
Review Comment:
@vkagamlyk we were thinking of the examples in each GLV module to be executed as part of the build against the current state of the driver code so that future breakages do not happen again (the examples are currently broken). The thought is to create a project level 'examples' folder which contains examples targeting latest released version which will not be executed as part of the build. Having a project-level examples folder also makes the examples more 'discoverable'.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "andreachild (via GitHub)" <gi...@apache.org>.
andreachild commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2369986433
##########
gremlin-dotnet/Examples/Connections/Connections.csproj:
##########
@@ -25,6 +25,6 @@ limitations under the License.
</PropertyGroup>
<ItemGroup>
- <PackageReference Include="Gremlin.Net" Version="3.7.0" />
+ <ProjectReference Include="../../src/Gremlin.Net/Gremlin.Net.csproj" />
Review Comment:
@vkagamlyk we were thinking of the examples in each GLV module to be executed as part of the build so that future breakages do not happen again (the examples are currently broken). The thought is to create a project level 'examples' folder which contains examples targeting latest released version which will not be executed as part of the build. Having a project-level examples folder also makes the examples more 'discoverable'.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "andreachild (via GitHub)" <gi...@apache.org>.
andreachild commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2370177074
##########
docs/src/reference/gremlin-variants.asciidoc:
##########
@@ -2092,29 +2165,54 @@ can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/greml
and are designed to connect to a running <<gremlin-server,Gremlin Server>> configured with the
`conf/gremlin-server.yaml` and `conf/gremlin-server-modern.yaml` files as included with the standard release packaging.
-To run the examples, first download an image of Gremlin Server from Docker Hub:
+There are two ways to run Gremlin Server for these examples:
+
+- *Running locally* – see the <<gremlin-server,Gremlin Server>> documentation.
+- *Running with Docker*:
+
[source,shell]
----
docker pull tinkerpop/gremlin-server
----
-The remote connection and basic Gremlin examples can be run on a clean server, which uses the default configuration file
-`conf/gremlin-server.yaml`. To start a clean server, launch a new container with `docker run`:
+Clean server:
+
[source,shell]
----
docker run -d -p 8182:8182 tinkerpop/gremlin-server
----
-The traversal examples should be run on a server configured to start with the Modern toy graph, using `conf/gremlin-server-modern.yaml`.
-To start a server with the Modern graph preloaded, launch a new container with `docker run`:
+Modern toy graph server:
+
[source,shell]
----
docker run -d -p 8182:8182 tinkerpop/gremlin-server conf/gremlin-server-modern.yaml
----
-Each example can now be run with the following command in their respective project directories:
+==== Prerequisites
+- .NET 8 SDK installed
+
+Navigate to the examples directory:
+
+[source,shell]
+----
+cd gremlin-dotnet/Examples
+----
+
+For each example project, navigate to its folder, then build and run:
Review Comment:
Q suggested the examples can be built and executed as such (without having to navigate to each folder):
```
# Build all projects
dotnet build Examples.sln
# Run specific examples
dotnet run --project BasicGremlin
dotnet run --project Connections
dotnet run --project ModernTraversals
```
Does this work?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "kirill-stepanishin (via GitHub)" <gi...@apache.org>.
kirill-stepanishin commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2371328397
##########
docs/src/reference/gremlin-variants.asciidoc:
##########
@@ -1263,19 +1278,60 @@ execute it.
=== Application Examples
The TinkerPop source code contains some sample applications that demonstrate the basics of Gremlin-Java. They
-can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/gremlin-driver/src/main/java/examples/[here].
+can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/gremlin-driver/src/main/java/examples/[here]
+and are designed to connect to a running <<gremlin-server,Gremlin Server>> configured with the
+`conf/gremlin-server.yaml` and `conf/gremlin-server-modern.yaml` files as included with the standard release packaging.
+
+There are two ways to run Gremlin Server for these examples:
-The remote connection examples in particular are designed to connect to a running <<gremlin-server,Gremlin Server>>
-configured with the `conf/gremlin-server.yaml` file as included with the standard release packaging.
+- *Running locally* – see the <<gremlin-server,Gremlin Server>> documentation.
+- *Running with Docker*:
-To do so, download an image of Gremlin Server from Docker Hub, then launch a new container with `docker run`:
[source,shell]
----
docker pull tinkerpop/gremlin-server
+----
+
+Clean server:
+
+[source,shell]
+----
docker run -d -p 8182:8182 tinkerpop/gremlin-server
----
-All examples can then be run using your IDE of choice.
+Modern toy graph server:
+
+[source,shell]
+----
+docker run -d -p 8182:8182 tinkerpop/gremlin-server conf/gremlin-server-modern.yaml
+----
+
+==== Prerequisites
+- Java 11 (JDK) installed
Review Comment:
Applied to all GLV prerequisites, thank you
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "vkagamlyk (via GitHub)" <gi...@apache.org>.
vkagamlyk commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2366311447
##########
gremlin-dotnet/Examples/Connections/Connections.csproj:
##########
@@ -25,6 +25,6 @@ limitations under the License.
</PropertyGroup>
<ItemGroup>
- <PackageReference Include="Gremlin.Net" Version="3.7.0" />
+ <ProjectReference Include="../../src/Gremlin.Net/Gremlin.Net.csproj" />
Review Comment:
The examples should work without the need to download the driver source code.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "kirill-stepanishin (via GitHub)" <gi...@apache.org>.
kirill-stepanishin commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2371238898
##########
gremlin-python/src/main/python/setup.py:
##########
@@ -35,7 +35,7 @@
fd.write("'''")
fd.write(__doc__)
fd.write("'''\n")
- fd.write('version = %r\n' % os.getenv('VERSION', '?').replace('-SNAPSHOT', '.dev-%d' % timestamp))
+ fd.write('version = %r\n' % os.getenv('VERSION', '999.999.999.dev0').replace('-SNAPSHOT', '.dev-%d' % timestamp))
Review Comment:
Without this change pip fails with `InvalidVersion: Invalid version: '-'` when installing the local package.
Maven Replacer would definitely be cleaner but would require a build step first, right now the examples run directly from source
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "Cole-Greer (via GitHub)" <gi...@apache.org>.
Cole-Greer commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2369398875
##########
gremlin-dotnet/Examples/BasicGremlin/BasicGremlin.csproj:
##########
@@ -25,6 +25,6 @@ limitations under the License.
</PropertyGroup>
<ItemGroup>
- <PackageReference Include="Gremlin.Net" Version="3.7.0" />
+ <PackageReference Include="Gremlin.Net" Version="3.7.4" />
Review Comment:
Nit: There is an inconsistency where the `BasicGremlin` and `ModernTraversals` examples are configured to use the latest released driver, and the `Connections` example is using the local dev build.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "andreachild (via GitHub)" <gi...@apache.org>.
andreachild commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2370130283
##########
docs/src/reference/gremlin-variants.asciidoc:
##########
@@ -1263,19 +1278,60 @@ execute it.
=== Application Examples
The TinkerPop source code contains some sample applications that demonstrate the basics of Gremlin-Java. They
-can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/gremlin-driver/src/main/java/examples/[here].
+can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/gremlin-driver/src/main/java/examples/[here]
+and are designed to connect to a running <<gremlin-server,Gremlin Server>> configured with the
+`conf/gremlin-server.yaml` and `conf/gremlin-server-modern.yaml` files as included with the standard release packaging.
+
+There are two ways to run Gremlin Server for these examples:
-The remote connection examples in particular are designed to connect to a running <<gremlin-server,Gremlin Server>>
-configured with the `conf/gremlin-server.yaml` file as included with the standard release packaging.
+- *Running locally* – see the <<gremlin-server,Gremlin Server>> documentation.
+- *Running with Docker*:
-To do so, download an image of Gremlin Server from Docker Hub, then launch a new container with `docker run`:
[source,shell]
----
docker pull tinkerpop/gremlin-server
+----
+
+Clean server:
+
+[source,shell]
+----
docker run -d -p 8182:8182 tinkerpop/gremlin-server
----
-All examples can then be run using your IDE of choice.
+Modern toy graph server:
+
+[source,shell]
+----
+docker run -d -p 8182:8182 tinkerpop/gremlin-server conf/gremlin-server-modern.yaml
+----
+
+==== Prerequisites
+- Java 11 (JDK) installed
Review Comment:
```suggestion
- Compatible JDK installed (see <<development-environment,Development Environment>> for supported versions
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "andreachild (via GitHub)" <gi...@apache.org>.
andreachild commented on PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#issuecomment-3325813358
VOTE +1 with the assumption that there will be a quick follow up PR to add GLV examples to the root module which are pinned to the latest released version or some other solution which would give new users access to examples that work out of the box without config changes with the latest released GLV versions. It would be helpful to prep that follow up PR while this one is waiting for votes so that they could be merged in quicker succession.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "kirill-stepanishin (via GitHub)" <gi...@apache.org>.
kirill-stepanishin commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2371326751
##########
docs/src/reference/gremlin-variants.asciidoc:
##########
@@ -525,27 +525,42 @@ can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/greml
and are designed to connect to a running <<gremlin-server,Gremlin Server>> configured with the
`conf/gremlin-server.yaml` and `conf/gremlin-server-modern.yaml` files as included with the standard release packaging.
-To run the examples, first download an image of Gremlin Server from Docker Hub:
+There are two ways to run Gremlin Server for these examples:
+
+- *Running locally* – see the <<gremlin-server,Gremlin Server>> documentation.
+- *Running with Docker*:
+
[source,shell]
----
docker pull tinkerpop/gremlin-server
----
-The remote connection and basic Gremlin examples can be run on a clean server, which uses the default configuration file
Review Comment:
That was an oversight, added a note about server configurations in 44abbe0. Thank you
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "vkagamlyk (via GitHub)" <gi...@apache.org>.
vkagamlyk commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2366311779
##########
gremlin-javascript/examples/node/package.json:
##########
@@ -9,6 +9,6 @@
"author": "Ryan Tan",
"license": "Apache-2.0",
"dependencies": {
- "gremlin": "^3.7.3"
+ "gremlin": "file:../../src/main/javascript/gremlin-javascript"
Review Comment:
same
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "kenhuuu (via GitHub)" <gi...@apache.org>.
kenhuuu commented on PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#issuecomment-3339615320
VOTE +1, pending nits.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve GLV examples reliability and documentation [tinkerpop]
Posted by "kenhuuu (via GitHub)" <gi...@apache.org>.
kenhuuu commented on code in PR #3213:
URL: https://github.com/apache/tinkerpop/pull/3213#discussion_r2382910941
##########
docs/src/reference/gremlin-variants.asciidoc:
##########
@@ -525,27 +525,43 @@ can be found in GitHub link:https://github.com/apache/tinkerpop/tree/x.y.z/greml
and are designed to connect to a running <<gremlin-server,Gremlin Server>> configured with the
`conf/gremlin-server.yaml` and `conf/gremlin-server-modern.yaml` files as included with the standard release packaging.
-To run the examples, first download an image of Gremlin Server from Docker Hub:
+This guide assumes Gremlin Server will be executed using Docker. Alternatively, Gremlin Server can run locally (see the <<gremlin-server,Gremlin Server>> documentation for this option).
+
+To start Gremlin Server using Docker, first download an image of Gremlin Server from Docker Hub:
+
[source,shell]
----
docker pull tinkerpop/gremlin-server
----
-The remote connection and basic Gremlin examples can be run on a clean server, which uses the default configuration file
-`conf/gremlin-server.yaml`. To start a clean server, launch a new container with `docker run`:
+Clean server:
+
[source,shell]
----
docker run -d -p 8182:8182 tinkerpop/gremlin-server
----
-The traversal examples should be run on a server configured to start with the Modern toy graph, using `conf/gremlin-server-modern.yaml`.
-To start a server with the Modern graph preloaded, launch a new container with `docker run`:
+Modern toy graph server:
+
[source,shell]
----
docker run -d -p 8182:8182 tinkerpop/gremlin-server conf/gremlin-server-modern.yaml
----
-Each example can now be run with the following commands:
+The remote connection and basic Gremlin examples can be run on a clean server, while traversal examples should be run on a server with the Modern graph preloaded.
Review Comment:
Nit: Try to maintain consistency in line length with the rest of the asciidoc files. This should break at 120 characters.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org