andreachild commented on code in PR #3218: URL: https://github.com/apache/tinkerpop/pull/3218#discussion_r2399527705
########## docs/src/reference/gremlin-variants.asciidoc: ########## @@ -1687,37 +1747,56 @@ 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/glv-examples/gremlin-javascript/[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: +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 ---- -Make sure to install all necessary packages: +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. + +==== Prerequisites +- Compatible Node.js installed (see <<development-environment,Development Environment>> for supported versions) +- npm installed + +Navigate to the examples directory: + +[source,shell] +---- +cd glv-examples/gremlin-javascript Review Comment: ```suggestion cd glv-examples/gremlin-javascript/node ``` -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
