summaryrefslogtreecommitdiffstats
path: root/release-notes
diff options
context:
space:
mode:
authorMaros Marsalek <mmarsale@cisco.com>2016-10-21 12:24:40 +0200
committerMarek Gradzki <mgradzki@cisco.com>2016-10-21 12:15:41 +0000
commitcbaa97311802aae42aa3e19660e37e9336f8f81e (patch)
tree37ffc0a3c19fcddbc672fecccd931cdd5544ae06 /release-notes
parent364aee69d63d434dc4feca42acd58b9b3edfaf90 (diff)
Fix attributes substitution in release_notes
Change-Id: I96ae1f6e5b21bf2db010758c8c0f4267aef59e93 Signed-off-by: Maros Marsalek <mmarsale@cisco.com> Signed-off-by: Marek Gradzki <mgradzki@cisco.com>
Diffstat (limited to 'release-notes')
-rw-r--r--release-notes/asciidoc/Readme.adoc4
-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
-rw-r--r--release-notes/src/main/asciidoc/install_guide/install_manual_build.adoc5
-rw-r--r--release-notes/src/main/asciidoc/user_guide/user_guide.adoc2
-rw-r--r--release-notes/src/main/asciidoc/user_guide/user_running_honeycomb.adoc3
6 files changed, 21 insertions, 9 deletions
diff --git a/release-notes/asciidoc/Readme.adoc b/release-notes/asciidoc/Readme.adoc
index d13917e..064e012 100644
--- a/release-notes/asciidoc/Readme.adoc
+++ b/release-notes/asciidoc/Readme.adoc
@@ -1,3 +1,5 @@
= release-notes-aggregator
-This module contains only release notes related documentation \ No newline at end of file
+This module contains only release notes related documentation.
+
+Full release notes can be found at link:release_notes.html[Release Notes]
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 496ec55..1efa49f 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 3f03c0b..ee148e5 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]
----
diff --git a/release-notes/src/main/asciidoc/install_guide/install_manual_build.adoc b/release-notes/src/main/asciidoc/install_guide/install_manual_build.adoc
index 6fa4caa..9248ddc 100644
--- a/release-notes/src/main/asciidoc/install_guide/install_manual_build.adoc
+++ b/release-notes/src/main/asciidoc/install_guide/install_manual_build.adoc
@@ -12,6 +12,7 @@ Building Honeycomb project requires:
== Obtain the honeycomb source code
TIP: Make sure you have https://wiki.fd.io/view/DEV/Setting_up_Gerrit[registered your ssh key with gerrit].
+[subs="+attributes"]
git clone ssh://[username]@gerrit.fd.io:29418/honeycomb
cd honeycomb
git checkout {project-branch}
@@ -42,6 +43,7 @@ Start VPP:
Install JVpp into local maven repository to make Honeycomb pick up the same JVpp version
+[subs="+attributes"]
cd build-vpp-native/vpp-api/java/
mvn install:install-file -Dfile=jvpp-registry-{project-vpp-version}.jar -DgroupId=io.fd.vpp -DartifactId=jvpp-registry -Dversion={project-vpp-snapshot-version} -Dpackaging=jar
mvn install:install-file -Dfile=jvpp-core-{project-vpp-version}.jar -DgroupId=io.fd.vpp -DartifactId=jvpp-core -Dversion={project-vpp-snapshot-version}-Dpackaging=jar
@@ -172,7 +174,8 @@ cd honeycomb/
Now Honeycomb can be run with:
- sudo sh vpp-integration/minimal-distribution/target/vpp-integration-distribution-1.16.9-SNAPSHOT-hc/vpp-integration-distribution-1.16.9-SNAPSHOT/honeycomb
+[subs="+attributes"]
+ sudo sh vpp-integration/minimal-distribution/target/vpp-integration-distribution-{project-version}-hc/vpp-integration-distribution-{project-version}/honeycomb
=== Building packages
After the code has been built, you can build an RPM or DEB package for honeycomb.
diff --git a/release-notes/src/main/asciidoc/user_guide/user_guide.adoc b/release-notes/src/main/asciidoc/user_guide/user_guide.adoc
index 494f2d2..7c7c453 100644
--- a/release-notes/src/main/asciidoc/user_guide/user_guide.adoc
+++ b/release-notes/src/main/asciidoc/user_guide/user_guide.adoc
@@ -15,7 +15,7 @@ Honeycomb's configuration files present within its distribution:
* Honeycomb infra:
** {project-git-web}/infra/minimal-distribution/src/main/resources/honeycomb-minimal-resources/config/honeycomb.json?h={project-branch}[Honeycomb base configuration]
* Honeycomb vpp plugins commons:
-** {project-git-web}/vpp-common/minimal-distribution/src/main/resources/honeycomb-minimal-resources/config/jvpp.json?h={project-branch}[VPP plugins common configuration]
+** {project-git-web}/vpp-common/vpp-common-integration/src/main/resources/honeycomb-minimal-resources/config/jvpp.json?h={project-branch}[VPP plugins common configuration]
* V3PO plugin:
** {project-git-web}/v3po/v3po2vpp/src/main/resources/honeycomb-minimal-resources/config/v3po.json?h={project-branch}[V3PO plugin for Honeycomb configuration]
* LISP plugin
diff --git a/release-notes/src/main/asciidoc/user_guide/user_running_honeycomb.adoc b/release-notes/src/main/asciidoc/user_guide/user_running_honeycomb.adoc
index 676bb1c..07b82a5 100644
--- a/release-notes/src/main/asciidoc/user_guide/user_running_honeycomb.adoc
+++ b/release-notes/src/main/asciidoc/user_guide/user_running_honeycomb.adoc
@@ -5,6 +5,7 @@ link:release_notes.html[< Home]
== Starting Honeycomb agent
The zipped vpp-integration distribution can be started by invoking:
+[subs="+attributes"]
sudo ./vpp-integration-distribution-{project-version}/honeycomb
This will start Honeycomb with all ODL dependencies and VPP translation code. It will automatically initialize vpp-jvpp to create interface between VPP and Honeycomb.
@@ -98,7 +99,7 @@ A notification should appear in opened NETCONF session.
====
Testing over RESTCONF is easier, and common calls can be found in this postman collection:
-*{project-git-web}/v3po/postman_rest_collection.json?h={project-branch}[V3PO postman collection][Honeycomb V3PO POSTMAN collection]*
+* {project-git-web}/v3po/postman_rest_collection.json?h={project-branch}[V3PO postman collection][Honeycomb V3PO POSTMAN collection]*
Each request in the collection contains equivalent VPP command (over CLI or VAT, whichever works) in the description.
====