TEIID-5575 updating archetype documentation

teiid · Dec 18, 2018 · 4009ac8 · 4009ac8
1 parent 90d4a61
commit 4009ac8
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 16 deletions.
diff --git a/book.json b/book.json
@@ -9,7 +9,7 @@
         "copyrightHolder" :  "Red Hat, Inc.",
         "javaVersionUrl" : "http://docs.oracle.com/javase/8",
         "asDocRoot" : "https://docs.jboss.org/author/display/WFLY/Documentation",
-        "archeTypeVersion" : "10.0.1"
+        "archeTypeVersion" : "12.0.0"
     },
     "plugins": ["collapsible-menu"]
 }
diff --git a/dev/Archetype_Template_Connector_Project.adoc b/dev/Archetype_Template_Connector_Project.adoc
@@ -37,7 +37,7 @@ To create a custom connector project from the command line, you can use the foll
 mvn archetype:generate       \
   -DarchetypeGroupId=org.teiid.arche-types                \
   -DarchetypeArtifactId=connector-archetype          \
-  -DarchetypeVersion=10.0.0               \
+  -DarchetypeVersion=${archetypeVersion}               \
   -DgroupId=${groupId}                  \
   -DartifactId=connector-${connector-type}  \
   -Dpackage=${package}    \
@@ -62,7 +62,7 @@ mvn archetype:generate       \
   -Dconnector-type  -  (user defined) the type of the new connector project, used in defining the package name
   -Dconnector-name  -  (user defined) the name of the new connector project, used as the prefix to creating the java class names
   -Dvendor-name     -  name of the Vendor for the data source, updates the rar
-  -Dteiid-version   -  [optional] the Teiid version the connector will depend upon
+  -Dteiid-version   -  the Teiid version the connector will depend upon
 
 
 *********
@@ -75,7 +75,7 @@ mvn archetype:generate       \
 mvn archetype:generate                    \
   -DarchetypeGroupId=org.teiid.arche-types   \
   -DarchetypeArtifactId=connector-archetype  \
-  -DarchetypeVersion=10.0.0  \
+  -DarchetypeVersion={{ book.archeTypeVersion }}  \
   -DgroupId=org.example  \
   -Dpackage=org.example.adapter.type \
   -DartifactId=adapter-type \

diff --git a/dev/Archetype_Template_PreParser_Project.adoc b/dev/Archetype_Template_PreParser_Project.adoc
@@ -39,7 +39,7 @@ To create a custom preparser project from the command line, you can use the foll
 mvn archetype:generate           \
   -DarchetypeGroupId=org.teiid.arche-types               \
   -DarchetypeArtifactId=preparser-archetype          \
-  -DarchetypeVersion=10.0.0     \
+  -DarchetypeVersion=${archetypeVersion}     \
   -DgroupId=${groupId}                  \
   -DartifactId=${preparser-artifact-id} \
   -Dpackage=${package}    \
@@ -61,7 +61,7 @@ mvn archetype:generate           \
   -Dpackage     -  (user defined) the package structure where the java, module and resource files will be created
   -Dversion     -  (user defined) the version that the new connector project pom.xml will be
   -Dclass-name      -  (user defined) the class name to give the new user preparser, will become the Class Name 
-  -Dteiid-version       -  Optional, defaults to 9.0.0.Final
+  -Dteiid-version   -  the Teiid version the connector will depend upon  
 ----
 
 *********
@@ -75,7 +75,7 @@ mvn archetype:generate           \
 mvn archetype:generate             \
   -DarchetypeGroupId=org.teiid.arche-types               \
   -DarchetypeArtifactId=preparser-archetype          \
-  -DarchetypeVersion=10.0.0    \
+  -DarchetypeVersion={{ book.archeTypeVersion }}    \
   -DgroupId=org.example   \
   -DartifactId=preparser-mypreparser    \
   -Dpackage=org.example.mypreparser    \

diff --git a/dev/Archetype_Template_Translator_Project.adoc b/dev/Archetype_Template_Translator_Project.adoc
@@ -38,7 +38,7 @@ To create a custom translator project from the command line, you can use the fol
 mvn archetype:generate               \
   -DarchetypeGroupId=org.teiid.arche-types               \
   -DarchetypeArtifactId=translator-archetype          \
-  -DarchetypeVersion=10.0.0               \
+  -DarchetypeVersion=${archetypeVersion}               \
   -DgroupId=${groupId}                  \
   -DartifactId=translator-${translator-type}    \
   -Dpackage=${package}    \
@@ -63,7 +63,7 @@ mvn archetype:generate               \
   -Dversion     -  (user defined) the version that the new connector project pom.xml will be
   -Dtranslator-type -  (user defined) the translator type that's used by Teiid when mapping the physical source to the translator to use 
   -Dtranslator-name -  (user defined) the translator name thats used for name the java class names
-  -Dteiid-version   -  [optional] the Teiid version the connector will depend upon, if not specified will default 
+  -Dteiid-version   -  the Teiid version the connector will depend upon
 ----
 
 *********
@@ -77,7 +77,7 @@ mvn archetype:generate               \
 mvn archetype:generate                    \
   -DarchetypeGroupId=org.teiid.arche-types   \
   -DarchetypeArtifactId=translator-archetype  \
-  -DarchetypeVersion=10.0.0  \
+  -DarchetypeVersion={{ book.archetypeVersion }}  \
   -DgroupId=org.example  \
   -DartifactId=translator-type  \
   -Dpackage=org.example.translator.type    \

diff --git a/dev/Archetype_Template_UDF_Project.adoc b/dev/Archetype_Template_UDF_Project.adoc
@@ -39,15 +39,16 @@ To create a custom translator project from the command line, you can use the fol
 mvn archetype:generate                         \
   -DarchetypeGroupId=org.teiid.arche-types               \
   -DarchetypeArtifactId=udf-archetype          \
-  -DarchetypeVersion=10.0.0     \
+  -DarchetypeVersion=${archetypeVersion}     \
   -DgroupId=${groupId}                  \
   -DartifactId=${udf-artifact-id}   \
   -Dpackage=${package}    \
   -Dversion=0.0.1-SNAPSHOT      \
   -Dudf-name=${functionName}  \
   -Dmethod-name=${methodName}      \
   -Dmethod-args=${methodArguments}   \
-  -Dreturn-type=${returnType}
+  -Dreturn-type=${returnType}      \
+  -Dteiid-version=${teiid-version}
 ----
 
 ********
@@ -67,6 +68,7 @@ mvn archetype:generate                         \
   -Dmethod-name         -  (user defined) the name of the method that will be configured in the model procedure
   -Dmethod-args         -  (user defined) the arguments the method will accept.  'Type name[, Type name[,...]]  Example:  'String arg0' or 'String arg0, integer arg1'
   -Dreturn-type         -  (user defined) the data type of the value returned by the method
+  -Dteiid-version   -  the Teiid version the connector will depend upon
 ----
 
 *********
@@ -80,15 +82,16 @@ mvn archetype:generate                         \
 mvn archetype:generate                           \
   -DarchetypeGroupId=org.teiid.arche-types               \
   -DarchetypeArtifactId=udf-archetype          \
-  -DarchetypeVersion=10.0.0     \
+  -DarchetypeVersion={{ book.archetypeVersion }}     \
   -DgroupId=org.example   \
   -DartifactId=udf-function    \
   -Dpackage=org.example.function    \
   -Dversion=0.0.1-SNAPSHOT      \
   -Dudf-name=Function \
   -Dmethod-name=function      \
   -Dmethod-args='String arg1'   \
-  -Dreturn-type=String
+  -Dreturn-type=String    \
+  -Dteiid-version=${teiid-version}
  
 ----
 

diff --git a/dev/Custom_Metadata_Repository.adoc b/dev/Custom_Metadata_Repository.adoc
@@ -1,7 +1,11 @@
 
 = Custom Metadata Repository
 
-If above provided link:../reference/Metadata_Repositories.adoc[metadata facilities] are not sufficient then a developer can extend the _MetadataRepository_ class provided in the _org.teiid.api_ jar to plug-in their own metadata facilities into the Teiid engine. For example, a user can write a metadata facility that is based on reading data from a database or a JCR repository. See link:Setting_up_the_build_environment.adoc[Setting up the build environment] to start development. For Example:
+If the provided link:../reference/Metadata_Repositories.adoc[metadata facilities] are not sufficient then a developer can extend the _MetadataRepository_ class provided in the _org.teiid.api_ jar to plug-in their own metadata facilities into the Teiid engine. For example, a user can write a metadata facility that is based on reading data from a database or a JCR repository. 
+
+See the arche-type for creating a https://github.com/teiid/teiid-tools/tree/master/arche-types/metadatarepository-archetype[custom metadata repository].
+
+Or see link:Setting_up_the_build_environment.adoc[setting up the build environment] to start development. For Example:
 
 [source,java]
 .*Sample Java Code*
@@ -44,7 +48,6 @@ Once the JAR file has been built, it needs to be deployed in the {{ book.asName
     </resources>
     <dependencies>
         <module name="javax.api"/>
-        <module name="javax.resource.api"/>
         <module name="org.teiid.common-core"/>
         <module name="org.teiid.teiid-api" />
     </dependencies>