summaryrefslogtreecommitdiffstats
path: root/tools/archetype/asciidoc
diff options
context:
space:
mode:
authorMaros Marsalek <mmarsale@cisco.com>2016-09-21 13:51:57 +0200
committerMaros Marsalek <mmarsale@cisco.com>2016-09-26 11:02:04 +0200
commitbc335de41876acd8720dce1030a79b3a7b39c3b1 (patch)
treec3b1b99c72fbcc36db5b7ff3e4c4e37680481eb0 /tools/archetype/asciidoc
parent09df17bb630b5bf594efbd9f869ef17da5e2b6ac (diff)
HONEYCOMB-209 Configure maven site
To produce site for Honeycomb + javadoc asciidoc To build the site: mvn clean install site:attach-descriptor site mvn site:stage -DstagingDirectory=/home/mmarsale/tmp/stage Change-Id: I4246bb09ba02b74a2a9c84ee73f8dba02384fffa Signed-off-by: Maros Marsalek <mmarsale@cisco.com>
Diffstat (limited to 'tools/archetype/asciidoc')
-rw-r--r--tools/archetype/asciidoc/Readme.adoc13
1 files changed, 13 insertions, 0 deletions
diff --git a/tools/archetype/asciidoc/Readme.adoc b/tools/archetype/asciidoc/Readme.adoc
new file mode 100644
index 000000000..e5528d7ee
--- /dev/null
+++ b/tools/archetype/asciidoc/Readme.adoc
@@ -0,0 +1,13 @@
+Honeycomb Plugin Archetype
+
+ This is archetype for creating plugins for Honeycomb platform
+
+How to use it :
+
+ archetype:generate -DarchetypeGroupId=io.fd.honeycomb.tools -DarchetypeArtifactId=honeycomb-plugin-archetype -DarchetypeVersion=1.16.12-SNAPSHOT
+
+This will generate main aggregator project containing two sub-projects
+
+ -api - project that should contain yang model files for restconf/netconf DTO classes
+ -impl - implementation project that should contain plugin translation code + wiring
+