This is an automated email from the ASF dual-hosted git repository.
shuber pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/unomi.git
The following commit(s) were added to refs/heads/master by this push:
new e4f33be [UNOMI-282] Add a documentation feature to provided online
manual in distribution
new e8d723f Merge pull request #133 from fpapon/UNOMI-282
e4f33be is described below
commit e4f33bee68ad2fd7323c7a7901f14bd4a499ac67
Author: Francois Papon <[email protected]>
AuthorDate: Mon Feb 17 22:21:38 2020 +0100
[UNOMI-282] Add a documentation feature to provided online manual in
distribution
---
generate-site-and-upload.sh | 15 +++----
generate-site.sh | 15 +++----
kar/src/main/feature/feature.xml | 5 +++
manual/pom.xml | 95 ++++++++++++++++++++++------------------
4 files changed, 68 insertions(+), 62 deletions(-)
diff --git a/generate-site-and-upload.sh b/generate-site-and-upload.sh
index e1b9834..66d9d0a 100755
--- a/generate-site-and-upload.sh
+++ b/generate-site-and-upload.sh
@@ -25,15 +25,10 @@ fi
echo Generating manual...
mvn clean
cd manual
-mvn -Phtml -Ddoc.source=src/archives/1.1/asciidoc
-Ddoc.output.html=target/generated-html/1_1_x
-mvn -Ppdf -Ddoc.source=src/archives/1.1/asciidoc
-Ddoc.output.pdf=target/generated-pdf/1_1_x
-mvn -Phtml -Ddoc.source=src/archives/1.2/asciidoc
-Ddoc.output.html=target/generated-html/1_2_x
-mvn -Ppdf -Ddoc.source=src/archives/1.2/asciidoc
-Ddoc.output.pdf=target/generated-pdf/1_2_x
-mvn -Phtml -Ddoc.source=src/archives/1.3/asciidoc
-Ddoc.output.html=target/generated-html/1_3_x
-mvn -Ppdf -Ddoc.source=src/archives/1.3/asciidoc
-Ddoc.output.pdf=target/generated-pdf/1_3_x
-mvn -Phtml -Ddoc.source=src/archives/1.4/asciidoc
-Ddoc.output.html=target/generated-html/1_4_x
-mvn -Ppdf -Ddoc.source=src/archives/1.4/asciidoc
-Ddoc.output.pdf=target/generated-pdf/1_4_x
-mvn -Phtml
+mvn -Ppdf -Ddoc.source=src/archives/1.1/asciidoc
-Ddoc.output.pdf=target/generated-docs/1_1_x
-Ddoc.output.html=target/generated-docs/1_1_x
+mvn -Ppdf -Ddoc.source=src/archives/1.2/asciidoc
-Ddoc.output.pdf=target/generated-docs/1_2_x
-Ddoc.output.html=target/generated-docs/1_2_x
+mvn -Ppdf -Ddoc.source=src/archives/1.3/asciidoc
-Ddoc.output.pdf=target/generated-docs/1_3_x
-Ddoc.output.html=target/generated-docs/1_3_x
+mvn -Ppdf -Ddoc.source=src/archives/1.4/asciidoc
-Ddoc.output.pdf=target/generated-docs/1_4_x
-Ddoc.output.html=target/generated-docs/1_4_x
mvn -Ppdf
cd ..
echo Generating Javadoc...
@@ -45,7 +40,7 @@ cd ..
mkdir -p target/staging/unomi-api
mkdir -p target/staging/manual
cp -R target/site/apidocs target/staging/unomi-api
-cp -Rf manual/target/generated-html/* target/staging/manual
+cp -Rf manual/target/generated-docs/html/* target/staging/manual
echo Committing documentation to Apache SVN...
mvn scm-publish:publish-scm
-Dscmpublish.pubScmUrl=scm:svn:https://svn.apache.org/repos/asf/unomi/website/manual
-Dscmpublish.content=target/staging/manual -Dusername=$1 -Dpassword=$2
mvn scm-publish:publish-scm
-Dscmpublish.pubScmUrl=scm:svn:https://svn.apache.org/repos/asf/unomi/website/unomi-api
-Dscmpublish.content=target/staging/unomi-api -Dusername=$1 -Dpassword=$2
diff --git a/generate-site.sh b/generate-site.sh
index 3b0d694..31943bf 100755
--- a/generate-site.sh
+++ b/generate-site.sh
@@ -20,15 +20,10 @@
echo Generating manual...
mvn clean
cd manual
-mvn -Phtml -Ddoc.source=src/archives/1.1/asciidoc
-Ddoc.output.html=target/generated-html/1_1_x
-mvn -Ppdf -Ddoc.source=src/archives/1.1/asciidoc
-Ddoc.output.pdf=target/generated-pdf/1_1_x
-mvn -Phtml -Ddoc.source=src/archives/1.2/asciidoc
-Ddoc.output.html=target/generated-html/1_2_x
-mvn -Ppdf -Ddoc.source=src/archives/1.2/asciidoc
-Ddoc.output.pdf=target/generated-pdf/1_2_x
-mvn -Phtml -Ddoc.source=src/archives/1.3/asciidoc
-Ddoc.output.html=target/generated-html/1_3_x
-mvn -Ppdf -Ddoc.source=src/archives/1.3/asciidoc
-Ddoc.output.pdf=target/generated-pdf/1_3_x
-mvn -Phtml -Ddoc.source=src/archives/1.4/asciidoc
-Ddoc.output.html=target/generated-html/1_4_x
-mvn -Ppdf -Ddoc.source=src/archives/1.4/asciidoc
-Ddoc.output.pdf=target/generated-pdf/1_4_x
-mvn -Phtml
+mvn -Ppdf -Ddoc.source=src/archives/1.1/asciidoc
-Ddoc.output.pdf=target/generated-docs/1_1_x
-Ddoc.output.html=target/generated-docs/1_1_x
+mvn -Ppdf -Ddoc.source=src/archives/1.2/asciidoc
-Ddoc.output.pdf=target/generated-docs/1_2_x
-Ddoc.output.html=target/generated-docs/1_2_x
+mvn -Ppdf -Ddoc.source=src/archives/1.3/asciidoc
-Ddoc.output.pdf=target/generated-docs/1_3_x
-Ddoc.output.html=target/generated-docs/1_3_x
+mvn -Ppdf -Ddoc.source=src/archives/1.4/asciidoc
-Ddoc.output.pdf=target/generated-docs/1_4_x
-Ddoc.output.html=target/generated-docs/1_4_x
mvn -Ppdf
cd ..
echo Generating Javadoc...
@@ -40,5 +35,5 @@ cd ..
mkdir -p target/staging/unomi-api
mkdir -p target/staging/manual
cp -R target/site/apidocs target/staging/unomi-api
-cp -Rf manual/target/generated-html/* target/staging/manual
+cp -Rf manual/target/generated-docs/html/* target/staging/manual
echo Documentation generation completed!
\ No newline at end of file
diff --git a/kar/src/main/feature/feature.xml b/kar/src/main/feature/feature.xml
index 2665b1e..9350b19 100644
--- a/kar/src/main/feature/feature.xml
+++ b/kar/src/main/feature/feature.xml
@@ -81,4 +81,9 @@
<bundle
start-level="99">mvn:org.apache.unomi/shell-commands/${project.version}</bundle>
</feature>
+
+ <feature name="unomi-documentation" description="Documentation of Unomi in
HTML" version="${project.version}">
+ <feature>war</feature>
+ <bundle>mvn:org.apache.unomi/manual/${project.version}</bundle>
+ </feature>
</features>
diff --git a/manual/pom.xml b/manual/pom.xml
index 71d44d6..5090545 100644
--- a/manual/pom.xml
+++ b/manual/pom.xml
@@ -30,53 +30,64 @@
<properties>
<doc.source>src/main/asciidoc</doc.source>
- <doc.output.html>target/generated-html/latest</doc.output.html>
- <doc.output.pdf>target/generated-pdf/latest</doc.output.pdf>
+ <doc.output.html>target/generated-docs/html</doc.output.html>
+ <doc.output.pdf>target/generated-docs/pdf</doc.output.pdf>
</properties>
-
- <profiles>
- <profile>
- <id>html</id>
- <build>
- <defaultGoal>process-resources</defaultGoal>
- <plugins>
- <plugin>
- <groupId>org.asciidoctor</groupId>
- <artifactId>asciidoctor-maven-plugin</artifactId>
- <version>1.6.0</version>
- <executions>
- <execution>
- <id>output-html</id>
- <phase>generate-resources</phase>
- <goals>
- <goal>process-asciidoc</goal>
- </goals>
- <configuration>
-
<sourceDocumentName>index.adoc</sourceDocumentName>
-
<sourceDirectory>${doc.source}</sourceDirectory>
-
<outputDirectory>${doc.output.html}</outputDirectory>
-
<preserveDirectories>true</preserveDirectories>
- <headerFooter>true</headerFooter>
- <imagesDir>${doc.source}/images</imagesDir>
- <backend>html5</backend>
- <doctype>article</doctype>
- <attributes>
- <toc />
- <linkcss>true</linkcss>
- <stylesheet>apache.css</stylesheet>
- <imagesdir>images</imagesdir>
- </attributes>
- </configuration>
- </execution>
- </executions>
+ <build>
+ <defaultGoal>process-resources</defaultGoal>
+ <plugins>
+ <plugin>
+ <groupId>org.asciidoctor</groupId>
+ <artifactId>asciidoctor-maven-plugin</artifactId>
+ <version>1.6.0</version>
+ <executions>
+ <execution>
+ <id>output-html</id>
+ <phase>generate-resources</phase>
+ <goals>
+ <goal>process-asciidoc</goal>
+ </goals>
<configuration>
+ <sourceDocumentName>index.adoc</sourceDocumentName>
+ <sourceDirectory>${doc.source}</sourceDirectory>
+
<outputDirectory>${doc.output.html}</outputDirectory>
+ <preserveDirectories>true</preserveDirectories>
+ <headerFooter>true</headerFooter>
+ <imagesDir>${doc.source}/images</imagesDir>
+ <backend>html5</backend>
+ <doctype>article</doctype>
+ <attributes>
+ <toc />
+ <linkcss>true</linkcss>
+ <stylesheet>apache.css</stylesheet>
+ <imagesdir>images</imagesdir>
+ </attributes>
</configuration>
- </plugin>
- </plugins>
- </build>
- </profile>
+ </execution>
+ </executions>
+ <configuration>
+ </configuration>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.felix</groupId>
+ <artifactId>maven-bundle-plugin</artifactId>
+ <inherited>true</inherited>
+ <extensions>true</extensions>
+ <configuration>
+ <instructions>
+ <Web-ContextPath>/documentation</Web-ContextPath>
+ <Import-Package>
+ org.slf4j;resolution:=optional
+ </Import-Package>
+
<Include-Resource>target/generated-docs/html</Include-Resource>
+ </instructions>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ <profiles>
<profile>
<id>pdf</id>
<build>
