summaryrefslogtreecommitdiffstats
path: root/release-notes
diff options
context:
space:
mode:
Diffstat (limited to 'release-notes')
-rw-r--r--release-notes/pom.xml45
-rw-r--r--release-notes/src/main/asciidoc/api_docs/api_docs.adoc3
-rw-r--r--release-notes/src/main/asciidoc/api_docs/api_docs_index.adoc19
-rw-r--r--release-notes/src/main/asciidoc/release_notes.adoc4
4 files changed, 70 insertions, 1 deletions
diff --git a/release-notes/pom.xml b/release-notes/pom.xml
index c06c22cf9..51a0bc359 100644
--- a/release-notes/pom.xml
+++ b/release-notes/pom.xml
@@ -31,6 +31,14 @@
<modelVersion>4.0.0</modelVersion>
<description>Hc2vpp release notes</description>
+ <dependencies>
+ <dependency>
+ <groupId>io.fd.hc2vpp.docs</groupId>
+ <artifactId>docs</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+ </dependencies>
+
<!-- Do not push, this is just a documentation producer -->
<build>
<plugins>
@@ -50,6 +58,25 @@
</plugin>
<plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-dependency-plugin</artifactId>
+ <version>2.10</version>
+ <executions>
+ <execution>
+ <id>unpack-configuration</id>
+ <phase>generate-sources</phase>
+ <goals>
+ <goal>unpack-dependencies</goal>
+ </goals>
+ <configuration>
+ <includes>*.adoc</includes>
+ <outputDirectory>${project.build.directory}/raw-adoc/api_docs</outputDirectory>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+
+ <plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<version>${asciidoctor.maven.plugin.version}</version>
@@ -63,6 +90,9 @@
<configuration>
<!-- https://github.com/asciidoctor/asciidoctor-maven-plugin -->
<!-- http://asciidoctor.org/docs/asciidoc-syntax-quick-reference -->
+ <!-- raw-adoc folder combines docs from src folder + generated api docs files,
+ in order to have them all available while generating site -->
+ <baseDir>${project.build.directory}/raw-adoc</baseDir>
<backend>html5</backend>
<doctype>docbook</doctype>
<sourceHighlighter>coderay</sourceHighlighter>
@@ -97,6 +127,21 @@
<artifactId>maven-resources-plugin</artifactId>
<executions>
<execution>
+ <id>copy-raw-adoc</id>
+ <phase>generate-sources</phase>
+ <goals>
+ <goal>copy-resources</goal>
+ </goals>
+ <configuration>
+ <outputDirectory>${project.build.directory}/raw-adoc</outputDirectory>
+ <resources>
+ <resource>
+ <directory>${project.basedir}/src/main/asciidoc/</directory>
+ </resource>
+ </resources>
+ </configuration>
+ </execution>
+ <execution>
<id>copy-release-notes-to-site</id>
<phase>site</phase>
<goals>
diff --git a/release-notes/src/main/asciidoc/api_docs/api_docs.adoc b/release-notes/src/main/asciidoc/api_docs/api_docs.adoc
new file mode 100644
index 000000000..5d519c68d
--- /dev/null
+++ b/release-notes/src/main/asciidoc/api_docs/api_docs.adoc
@@ -0,0 +1,3 @@
+== API documentation
+
+link:api_docs_index.html[VPP API to Yang index]
diff --git a/release-notes/src/main/asciidoc/api_docs/api_docs_index.adoc b/release-notes/src/main/asciidoc/api_docs/api_docs_index.adoc
new file mode 100644
index 000000000..08dfeb28f
--- /dev/null
+++ b/release-notes/src/main/asciidoc/api_docs/api_docs_index.adoc
@@ -0,0 +1,19 @@
+== VPP api to Yang index
+
+// TODO - generate this file based on list of JVPP plugins used
+
+Mapping between VPP binary apis and JVpp binding in hc2vpp
+
+include::api_docs/futurejvppcore-yang-config-index.adoc[JVpp Core plugin docs]
+
+include::api_docs/futurejvppacl-yang-config-index.adoc[JVpp Acl plugin docs]
+
+include::api_docs/futurejvppsnat-yang-config-index.adoc[JVpp Snat plugin docs]
+
+include::api_docs/futurejvppnsh-yang-config-index.adoc[JVpp Nsh plugin docs]
+
+include::api_docs/futurejvppioamtrace-yang-config-index.adoc[JVpp Ioam Trace plugin docs]
+
+include::api_docs/futurejvppioampot-yang-config-index.adoc[JVpp Ioam Pot plugin docs]
+
+include::api_docs/futurejvppioamexport-yang-config-index.adoc[JVpp Ioam Export plugin docs]
diff --git a/release-notes/src/main/asciidoc/release_notes.adoc b/release-notes/src/main/asciidoc/release_notes.adoc
index e4e1588d5..605eda69d 100644
--- a/release-notes/src/main/asciidoc/release_notes.adoc
+++ b/release-notes/src/main/asciidoc/release_notes.adoc
@@ -26,4 +26,6 @@ include::install_guide/install_guide.adoc[]
include::user_guide/user_guide.adoc[]
-include::devel_guide/devel_guide.adoc[] \ No newline at end of file
+include::devel_guide/devel_guide.adoc[]
+
+include::api_docs/api_docs.adoc[] \ No newline at end of file