This is an automated email from the ASF dual-hosted git repository. spmallette pushed a commit to branch TINKERPOP-2002 in repository https://gitbox.apache.org/repos/asf/tinkerpop.git
commit 6ce06056c892b8fef05bda56df156e841ff9377b Author: Stephen Mallette <sp...@genoprime.com> AuthorDate: Mon Nov 12 13:25:25 2018 -0500 TINKERPOP-2002 Moved templates/archetypes to variant sections --- docs/src/reference/gremlin-applications.asciidoc | 47 ------------------------ docs/src/reference/gremlin-variants.asciidoc | 46 +++++++++++++++++++++++ 2 files changed, 46 insertions(+), 47 deletions(-) diff --git a/docs/src/reference/gremlin-applications.asciidoc b/docs/src/reference/gremlin-applications.asciidoc index ac56fc0..83a59db 100644 --- a/docs/src/reference/gremlin-applications.asciidoc +++ b/docs/src/reference/gremlin-applications.asciidoc @@ -2283,50 +2283,3 @@ The following shows the output for `HadoopGraph`: ---- describeGraph(HadoopGraph) ---- - -[[application-templates]] -== Application Templates - -TinkerPop has a number of application templates, which provide example project templates to quickly get started with TinkerPop. - -[[gremlin-archetypes]] -=== Maven Archetypes - -The available link:https://maven.apache.org/guides/introduction/introduction-to-archetypes.html[Maven archetypes] are as follows: - -* `gremlin-archetype-dsl` - An example project that demonstrates how to build Domain Specific Languages with Gremlin in Java. -* `gremlin-archetype-server` - An example project that demonstrates the basic structure of a -<<gremlin-server,Gremlin Server>> project, how to connect with the Gremlin Driver, and how to embed Gremlin Server in -a testing framework. -* `gremlin-archetype-tinkergraph` - A basic example of how to structure a TinkerPop project with Maven. - -You can use Maven to generate these example projects with a command like: - -[source,shell] -$ mvn archetype:generate -DarchetypeGroupId=org.apache.tinkerpop -DarchetypeArtifactId=gremlin-archetype-server - -DarchetypeVersion=x.y.z -DgroupId=com.my -DartifactId=app -Dversion=0.1 -DinteractiveMode=false - -This command will generate a new Maven project in a directory called "app" with a `pom.xml` specifying a `groupId` of -`com.my`. Please see the `README.asciidoc` in the root of each generated project for information on how to build and -execute it. - -[[gremlin-dotnet-template]] -=== Gremlin.Net Template - -This link:https://docs.microsoft.com/dotnet/core/tools/custom-templates[dotnet template] helps getting started with -<<gremlin-DotNet,Gremlin.Net>>. It creates a new C# console project that shows how to connect to a -<<gremlin-server,Gremlin Server>> with Gremlin.Net. - -You can install the template with the dotnet CLI tool: -[source,shell] -dotnet new -i Gremlin.Net.Template - -After the template is installed, a new project based on this template can be installed: - -[source,shell] -dotnet new gremlin - -You can specify the output directory for the new project which will then also be used as the name of the created project: - -[source,shell] -dotnet new gremlin -o MyFirstGremlinProject diff --git a/docs/src/reference/gremlin-variants.asciidoc b/docs/src/reference/gremlin-variants.asciidoc index ce39ed8..4da0c66 100644 --- a/docs/src/reference/gremlin-variants.asciidoc +++ b/docs/src/reference/gremlin-variants.asciidoc @@ -542,6 +542,30 @@ social.persons("marko").knows("josh"); NOTE: Using Maven, as shown in the `gremlin-archetype-dsl` module, makes developing DSLs with the annotation processor straightforward in that it sets up appropriate paths to the generated code automatically. +[[gremlin-archetypes]] +[[java-application-examples]] +=== Application Examples + +The available link:https://maven.apache.org/guides/introduction/introduction-to-archetypes.html[Maven archetypes] are +as follows: + +* `gremlin-archetype-dsl` - An example project that demonstrates how to build Domain Specific Languages with Gremlin +in Java. +* `gremlin-archetype-server` - An example project that demonstrates the basic structure of a +<<gremlin-server,Gremlin Server>> project, how to connect with the Gremlin Driver, and how to embed Gremlin Server in +a testing framework. +* `gremlin-archetype-tinkergraph` - A basic example of how to structure a TinkerPop project with Maven. + +Use Maven to generate these example projects with a command like: + +[source,shell] +$ mvn archetype:generate -DarchetypeGroupId=org.apache.tinkerpop -DarchetypeArtifactId=gremlin-archetype-server \ + -DarchetypeVersion=x.y.z -DgroupId=com.my -DartifactId=app -Dversion=0.1 -DinteractiveMode=false + +This command will generate a new Maven project in a directory called "app" with a `pom.xml` specifying a `groupId` of +`com.my`. Please see the `README.asciidoc` in the root of each generated project for information on how to build and +execute it. + [[gremlin-groovy]] == Gremlin-Groovy @@ -1119,6 +1143,28 @@ social.Persons("marko").YoungestFriendsAge(); social.Persons().Filter(CreatedAtLeast(2)).Count(); ---- +[[gremlin-dotnet-template]] +[[dotnet-application-examples]] +=== Application Examples + +This link:https://docs.microsoft.com/dotnet/core/tools/custom-templates[dotnet template] helps getting started with +<<gremlin-DotNet,Gremlin.Net>>. It creates a new C# console project that shows how to connect to a +<<gremlin-server,Gremlin Server>> with Gremlin.Net. + +You can install the template with the dotnet CLI tool: +[source,shell] +dotnet new -i Gremlin.Net.Template + +After the template is installed, a new project based on this template can be installed: + +[source,shell] +dotnet new gremlin + +Specify the output directory for the new project which will then also be used as the name of the created project: + +[source,shell] +dotnet new gremlin -o MyFirstGremlinProject + [[gremlin-javascript]] == Gremlin-JavaScript