andreachild commented on code in PR #3218: URL: https://github.com/apache/tinkerpop/pull/3218#discussion_r2399493460
########## glv-examples/README.md: ########## @@ -0,0 +1,98 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> + +# TinkerPop GLV Examples + +This directory contains ready-to-run examples for all Gremlin Language Variants (GLVs) using the latest published driver versions. These examples work out-of-the-box without requiring you to build TinkerPop from source. + +## Server Configuration + +**Important**: Different examples require different server configurations: + +- **BasicGremlin & Connections**: Use clean server with `conf/gremlin-server.yaml` +- **ModernTraversals**: Requires server with Modern graph preloaded using `conf/gremlin-server-modern.yaml` + +Start server with Docker: +```bash +# For BasicGremlin and Connections +docker run -d -p 8182:8182 tinkerpop/gremlin-server conf/gremlin-server.yaml Review Comment: Nit: unsure if these commands should also assume the user is currently in the `glv-examples` directory or not (the commands to run the examples assume so) ########## glv-examples/README.md: ########## @@ -0,0 +1,98 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> + +# TinkerPop GLV Examples + +This directory contains ready-to-run examples for all Gremlin Language Variants (GLVs) using the latest published driver versions. These examples work out-of-the-box without requiring you to build TinkerPop from source. + +## Server Configuration + +**Important**: Different examples require different server configurations: + +- **BasicGremlin & Connections**: Use clean server with `conf/gremlin-server.yaml` +- **ModernTraversals**: Requires server with Modern graph preloaded using `conf/gremlin-server-modern.yaml` + +Start server with Docker: +```bash +# For BasicGremlin and Connections +docker run -d -p 8182:8182 tinkerpop/gremlin-server conf/gremlin-server.yaml Review Comment: Nit: unsure if these docker commands should also assume the user is currently in the `glv-examples` directory or not (the commands to run the examples assume so) -- 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]
