summaryrefslogtreecommitdiffstats
path: root/release-notes/src/main/asciidoc/devel_guide
diff options
context:
space:
mode:
Diffstat (limited to 'release-notes/src/main/asciidoc/devel_guide')
-rw-r--r--release-notes/src/main/asciidoc/devel_guide/devel_plugin_tutorial.adoc8
-rw-r--r--release-notes/src/main/asciidoc/devel_guide/devel_plugin_vpp_tutorial.adoc8
2 files changed, 11 insertions, 5 deletions
diff --git a/release-notes/src/main/asciidoc/devel_guide/devel_plugin_tutorial.adoc b/release-notes/src/main/asciidoc/devel_guide/devel_plugin_tutorial.adoc
index 496ec55d1..1efa49f04 100644
--- a/release-notes/src/main/asciidoc/devel_guide/devel_plugin_tutorial.adoc
+++ b/release-notes/src/main/asciidoc/devel_guide/devel_plugin_tutorial.adoc
@@ -8,10 +8,12 @@ Since Honeycomb is a generic agent. Any plugin (translation code) can be injecte
Honeycomb provides a maven archetype to generate a plugin skeleton. To use that archetype, run maven:
+[subs="+attributes"]
mvn -X archetype:generate -DarchetypeGroupId=io.fd.honeycomb.tools -DarchetypeArtifactId=honeycomb-plugin-archetype -DarchetypeVersion={project-version}
Fill in the parameters e.g.
+[subs="+attributes"]
groupId: io.fd.honeycomb.tutorial
artifactId: sample-plugin
version: {project-version}
@@ -202,7 +204,7 @@ A new maven module needs to be created. So in sample-plugin folder:
Then create the pom:
-[source,xml]
+[source,xml,subs="+attributes"]
----
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
@@ -330,8 +332,10 @@ tar.gz archive
folder
The distribution can be started by:
+[subs="attributes"]
sudo ./sample-distribution/target/sample-distribution-{project-version}-hc/sample-distribution-{project-version}/honeycomb
-Note: honeycomb-start script is the background alternative
+
+NOTE: honeycomb-start script is the background alternative
Honeycomb will display following message in the log:
diff --git a/release-notes/src/main/asciidoc/devel_guide/devel_plugin_vpp_tutorial.adoc b/release-notes/src/main/asciidoc/devel_guide/devel_plugin_vpp_tutorial.adoc
index 3f03c0b48..ee148e5e5 100644
--- a/release-notes/src/main/asciidoc/devel_guide/devel_plugin_vpp_tutorial.adoc
+++ b/release-notes/src/main/asciidoc/devel_guide/devel_plugin_vpp_tutorial.adoc
@@ -58,7 +58,7 @@ Now rebuild the *-api module.
=== JVpp dependency
Another important thing that the plugin needs is dependency to VPP's JVpp (Java APIs). To do so, just update *-impl's pom.xml with:
-[source,xml]
+[source,xml,subs="+attributes"]
----
<!-- VPP's core Java APIs -->
<dependency>
@@ -70,7 +70,7 @@ Another important thing that the plugin needs is dependency to VPP's JVpp (Java
Also add vpp-translate-utils dependency so that writing translation code is easier:
-[source,xml]
+[source,xml,subs="+attributes"]
----
<dependency>
<groupId>io.fd.honeycomb.vpp</groupId>
@@ -516,7 +516,8 @@ In order to add this new plugin into vpp-integration:
* clone honeycomb codebase (since that's the home of vpp-integration distribution)
* add a dependency for this sample plugin in vpp-integration distribution (honeycomb/vpp-integration/minimal-distribution/pom.xml):
-[source,xml]
+
+[source,xml,subs="+attributes"]
----
<dependency>
<groupId>io.fd.honeycomb.tutorial</groupId>
@@ -524,6 +525,7 @@ In order to add this new plugin into vpp-integration:
<version>{project-version}</version>
</dependency>
----
+
* modify Main of vpp-integration distribution to include sample-plugin (/home/mmarsale/Projects/honeycomb/vpp-integration/minimal-distribution/src/main/java/io/fd/honeycomb/vpp/integration/distro/Main.java):
[source,java]
----