You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by kw...@apache.org on 2021/05/13 10:51:32 UTC
[jackrabbit-filevault] 01/01: releng: move site generation to
reactor level
This is an automated email from the ASF dual-hosted git repository.
kwin pushed a commit to branch feature/generate-site-from-reactor
in repository https://gitbox.apache.org/repos/asf/jackrabbit-filevault.git
commit 2c5e665c8e6c7d822a0226f0dae8d19c203b7b8f
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Thu May 13 12:51:20 2021 +0200
releng: move site generation to reactor level
This makes it easier to generate the site including (aggregate) javadoc
in one command
---
README.md | 28 +++++
parent/pom.xml | 1 +
pom.xml | 99 ++++++++++++++--
{vault-doc/src => src}/site/markdown/config.md | 0
{vault-doc/src => src}/site/markdown/docview.md | 0
{vault-doc/src => src}/site/markdown/filter.md | 0
.../src => src}/site/markdown/howto_release.md | 0
{vault-doc/src => src}/site/markdown/importmode.md | 0
src/site/markdown/index.md | 5 +
.../src => src}/site/markdown/installhooks.md | 0
{vault-doc/src => src}/site/markdown/metadata.md | 0
{vault-doc/src => src}/site/markdown/nodetypes.md | 0
{vault-doc/src => src}/site/markdown/overview.md | 0
.../src => src}/site/markdown/packagetypes.md | 0
{vault-doc/src => src}/site/markdown/privileges.md | 0
{vault-doc/src => src}/site/markdown/properties.md | 0
{vault-doc/src => src}/site/markdown/rcp.md | 0
{vault-doc/src => src}/site/markdown/settings.md | 0
{vault-doc/src => src}/site/markdown/usage.md | 0
{vault-doc/src => src}/site/markdown/validation.md | 0
{vault-doc/src => src}/site/markdown/vault_api.png | Bin
.../src => src}/site/markdown/vault_sample.png | Bin
{vault-doc/src => src}/site/markdown/vaultfs.md | 0
{vault-doc/src => src}/site/markdown/vaultfs.png | Bin
.../site/markdown/wip/package_handling.md | 0
{vault-doc/src => src}/site/resources/asf_logo.png | Bin
{vault-doc/src => src}/site/resources/css/site.css | 0
{vault-doc/src => src}/site/resources/favicon.ico | Bin
.../src => src}/site/resources/jackrabbit.png | Bin
{vault-doc/src => src}/site/site.xml | 3 +-
vault-doc/README.md | 48 --------
vault-doc/pom.xml | 132 ---------------------
32 files changed, 126 insertions(+), 190 deletions(-)
diff --git a/README.md b/README.md
index 3530aaf..76e22f8 100644
--- a/README.md
+++ b/README.md
@@ -37,6 +37,34 @@ For more instructions, please see the documentation at:
<https://jackrabbit.apache.org/building-jackrabbit.html>
+Building FileVault Site
+============================================
+
+The FileVault documentation lives as Markdown files in `src/site/markdown` such
+that it easy to view e.g. from GitHub. Alternatively the Maven site plugin
+can be used to build and deploy a web site as follows:
+
+1. From the reactor build the site with javadoc:
+
+ $ mvn site
+
+2. Review the site at `target/site`
+3. Deploy the site to `http://jackrabbit.apache.org/filevault/` using:
+
+ $ cd vault-doc
+ $ mvn site-deploy
+
+4. Finally review the site at `http://jackrabbit.apache.org/filevault/index.html`.
+
+
+Note: To skip the final commit use `-Dscmpublish.skipCheckin=true`. You can then
+review all pending changes in `vault-doc/target/scmpublish-checkout` and follow
+up with `svn commit` manually.
+
+Note: Every committer should be able to deploy the site. No fiddling with
+credentials needed since deployment is done via svn commit to
+`https://svn.apache.org/repos/asf/jackrabbit/site/live/filevault`.
+
License (see also LICENSE)
==============================
diff --git a/parent/pom.xml b/parent/pom.xml
index aace9c3..ae50f0e 100644
--- a/parent/pom.xml
+++ b/parent/pom.xml
@@ -264,6 +264,7 @@ Bundle-Category: jackrabbit
<artifactId>maven-site-plugin</artifactId>
<version>3.9.1</version>
<configuration>
+ <skip>true</skip><!-- skip for all modules where not explicitly enabled -->
<skipDeploy>true</skipDeploy><!-- always deploy via maven-scm-publish-plugin -->
</configuration>
<dependencies>
diff --git a/pom.xml b/pom.xml
index ac001a5..9d2d5bf 100644
--- a/pom.xml
+++ b/pom.xml
@@ -44,7 +44,6 @@
<module>vault-diff</module>
<module>vault-rcp</module>
<module>vault-davex</module>
- <module>vault-doc</module>
<module>vault-vlt</module>
<module>vault-cli</module>
<module>vault-hook-example</module>
@@ -57,6 +56,13 @@
<project.build.outputTimestamp>2021-02-26T08:34:48Z</project.build.outputTimestamp>
</properties>
+ <distributionManagement>
+ <site>
+ <id>jackrabbit.filevault.site-deploy</id>
+ <url>scm:svn:https://svn.apache.org/repos/asf/jackrabbit/site/live/filevault</url>
+ </site>
+ </distributionManagement>
+
<!-- ====================================================================== -->
<!-- B U I L D -->
<!-- ====================================================================== -->
@@ -88,6 +94,65 @@
</plugin>
</plugins>
</pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-site-plugin</artifactId>
+ <configuration>
+ <generateReports>true</generateReports>
+ <skip>false</skip>
+ <relativizeDecorationLinks>false</relativizeDecorationLinks>
+ </configuration>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-scm-publish-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>scm-publish</id>
+ <phase>site-deploy</phase>
+ <goals>
+ <goal>publish-scm</goal>
+ </goals>
+ </execution>
+ </executions>
+ <configuration>
+ <content>target/site</content>
+ <checkinComment>@trivial: Site checkin for project ${project.name}-${project.version}
+ </checkinComment>
+ <ignorePathsToDelete>
+ <ignorePathToDelete>apidocs</ignorePathToDelete>
+ </ignorePathsToDelete>
+ </configuration>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-resources-plugin</artifactId>
+ <executions>
+ <execution>
+ <phase>pre-site</phase>
+ <goals>
+ <goal>resources</goal>
+ </goals>
+ </execution>
+ </executions>
+ <configuration>
+ <outputDirectory>${project.build.directory}/site</outputDirectory>
+ </configuration>
+ </plugin>
+ </plugins>
+
+ <resources>
+ <resource>
+ <directory>src/site/markdown</directory>
+ <includes>
+ <include>*.png</include>
+ <include>*.jpg</include>
+ <include>*.jpeg</include>
+ <include>*.gif</include>
+ </includes>
+ </resource>
+ </resources>
</build>
<!-- ====================================================================== -->
@@ -102,10 +167,35 @@
<reportSet>
<!-- only generate aggregate report (not main and test, https://maven.apache.org/plugins/maven-javadoc-plugin/examples/selective-javadocs-report.html) -->
<id>aggregate</id>
+ <inherited>false</inherited>
<reports>
<report>aggregate</report>
</reports>
</reportSet>
+ <reportSet>
+ <id>default</id>
+ <reports>
+ <report>javadoc</report>
+ </reports>
+ </reportSet>
+ </reportSets>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-project-info-reports-plugin</artifactId>
+ <reportSets>
+ <reportSet>
+ <reports>
+ <!-- don't generate index, due to the links to modules not having sites -->
+ <report>team</report>
+ <report>mailing-lists</report>
+ <report>ci-management</report>
+ <report>issue-management</report>
+ <report>licenses</report>
+ <report>scm</report>
+ <report>distribution-management</report>
+ </reports>
+ </reportSet>
</reportSets>
</plugin>
</plugins>
@@ -128,13 +218,6 @@
<artifactId>maven-javadoc-plugin</artifactId>
<executions>
<execution>
- <id>aggregate</id>
- <goals>
- <goal>aggregate</goal>
- </goals>
- <phase>site</phase>
- </execution>
- <execution>
<id>aggregate-jar</id>
<goals>
<goal>aggregate-jar</goal>
diff --git a/vault-doc/src/site/markdown/config.md b/src/site/markdown/config.md
similarity index 100%
rename from vault-doc/src/site/markdown/config.md
rename to src/site/markdown/config.md
diff --git a/vault-doc/src/site/markdown/docview.md b/src/site/markdown/docview.md
similarity index 100%
rename from vault-doc/src/site/markdown/docview.md
rename to src/site/markdown/docview.md
diff --git a/vault-doc/src/site/markdown/filter.md b/src/site/markdown/filter.md
similarity index 100%
rename from vault-doc/src/site/markdown/filter.md
rename to src/site/markdown/filter.md
diff --git a/vault-doc/src/site/markdown/howto_release.md b/src/site/markdown/howto_release.md
similarity index 100%
rename from vault-doc/src/site/markdown/howto_release.md
rename to src/site/markdown/howto_release.md
diff --git a/vault-doc/src/site/markdown/importmode.md b/src/site/markdown/importmode.md
similarity index 100%
rename from vault-doc/src/site/markdown/importmode.md
rename to src/site/markdown/importmode.md
diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md
new file mode 100644
index 0000000..523f58f
--- /dev/null
+++ b/src/site/markdown/index.md
@@ -0,0 +1,5 @@
+# Apache Jackrabbit FileVault
+
+The FileVault introduces a JCR repository to filesystem mapping. The mapping is exposed by an API and used by the "FileVault Content Packages" which allow to create portable packages of repository content. The Vault Command Line Interface aka "vlt" provides a subversion like utility to work and develop with repository content.
+
+Apache Jackrabbit FileVault is a project of the Apache Software Foundation.
\ No newline at end of file
diff --git a/vault-doc/src/site/markdown/installhooks.md b/src/site/markdown/installhooks.md
similarity index 100%
rename from vault-doc/src/site/markdown/installhooks.md
rename to src/site/markdown/installhooks.md
diff --git a/vault-doc/src/site/markdown/metadata.md b/src/site/markdown/metadata.md
similarity index 100%
rename from vault-doc/src/site/markdown/metadata.md
rename to src/site/markdown/metadata.md
diff --git a/vault-doc/src/site/markdown/nodetypes.md b/src/site/markdown/nodetypes.md
similarity index 100%
rename from vault-doc/src/site/markdown/nodetypes.md
rename to src/site/markdown/nodetypes.md
diff --git a/vault-doc/src/site/markdown/overview.md b/src/site/markdown/overview.md
similarity index 100%
rename from vault-doc/src/site/markdown/overview.md
rename to src/site/markdown/overview.md
diff --git a/vault-doc/src/site/markdown/packagetypes.md b/src/site/markdown/packagetypes.md
similarity index 100%
rename from vault-doc/src/site/markdown/packagetypes.md
rename to src/site/markdown/packagetypes.md
diff --git a/vault-doc/src/site/markdown/privileges.md b/src/site/markdown/privileges.md
similarity index 100%
rename from vault-doc/src/site/markdown/privileges.md
rename to src/site/markdown/privileges.md
diff --git a/vault-doc/src/site/markdown/properties.md b/src/site/markdown/properties.md
similarity index 100%
rename from vault-doc/src/site/markdown/properties.md
rename to src/site/markdown/properties.md
diff --git a/vault-doc/src/site/markdown/rcp.md b/src/site/markdown/rcp.md
similarity index 100%
rename from vault-doc/src/site/markdown/rcp.md
rename to src/site/markdown/rcp.md
diff --git a/vault-doc/src/site/markdown/settings.md b/src/site/markdown/settings.md
similarity index 100%
rename from vault-doc/src/site/markdown/settings.md
rename to src/site/markdown/settings.md
diff --git a/vault-doc/src/site/markdown/usage.md b/src/site/markdown/usage.md
similarity index 100%
rename from vault-doc/src/site/markdown/usage.md
rename to src/site/markdown/usage.md
diff --git a/vault-doc/src/site/markdown/validation.md b/src/site/markdown/validation.md
similarity index 100%
rename from vault-doc/src/site/markdown/validation.md
rename to src/site/markdown/validation.md
diff --git a/vault-doc/src/site/markdown/vault_api.png b/src/site/markdown/vault_api.png
similarity index 100%
rename from vault-doc/src/site/markdown/vault_api.png
rename to src/site/markdown/vault_api.png
diff --git a/vault-doc/src/site/markdown/vault_sample.png b/src/site/markdown/vault_sample.png
similarity index 100%
rename from vault-doc/src/site/markdown/vault_sample.png
rename to src/site/markdown/vault_sample.png
diff --git a/vault-doc/src/site/markdown/vaultfs.md b/src/site/markdown/vaultfs.md
similarity index 100%
rename from vault-doc/src/site/markdown/vaultfs.md
rename to src/site/markdown/vaultfs.md
diff --git a/vault-doc/src/site/markdown/vaultfs.png b/src/site/markdown/vaultfs.png
similarity index 100%
rename from vault-doc/src/site/markdown/vaultfs.png
rename to src/site/markdown/vaultfs.png
diff --git a/vault-doc/src/site/markdown/wip/package_handling.md b/src/site/markdown/wip/package_handling.md
similarity index 100%
rename from vault-doc/src/site/markdown/wip/package_handling.md
rename to src/site/markdown/wip/package_handling.md
diff --git a/vault-doc/src/site/resources/asf_logo.png b/src/site/resources/asf_logo.png
similarity index 100%
rename from vault-doc/src/site/resources/asf_logo.png
rename to src/site/resources/asf_logo.png
diff --git a/vault-doc/src/site/resources/css/site.css b/src/site/resources/css/site.css
similarity index 100%
rename from vault-doc/src/site/resources/css/site.css
rename to src/site/resources/css/site.css
diff --git a/vault-doc/src/site/resources/favicon.ico b/src/site/resources/favicon.ico
similarity index 100%
rename from vault-doc/src/site/resources/favicon.ico
rename to src/site/resources/favicon.ico
diff --git a/vault-doc/src/site/resources/jackrabbit.png b/src/site/resources/jackrabbit.png
similarity index 100%
rename from vault-doc/src/site/resources/jackrabbit.png
rename to src/site/resources/jackrabbit.png
diff --git a/vault-doc/src/site/site.xml b/src/site/site.xml
similarity index 98%
rename from vault-doc/src/site/site.xml
rename to src/site/site.xml
index d6ffe0a..94715c3 100644
--- a/vault-doc/src/site/site.xml
+++ b/src/site/site.xml
@@ -45,14 +45,13 @@
<item href="nodetypes.html" name="Node Types"/>
<item href="privileges.html" name="Privileges"/>
<item href="installhooks.html" name="Install Hooks"/>
- </item>
+ </item>
<item href="rcp.html" name="Vault Remote Copy" />
</menu>
<menu name="Developing">
<item href="apidocs/index.html" name="API docs" />
<item href="howto_release.html" name="How to create a release" />
</menu>
- <menu ref="modules"/>
<menu ref="reports" inherit="bottom"/>
<menu name="Links">
<item href="https://jackrabbit.apache.org/filevault-package-maven-plugin" name="Apache Jackrabbit FileVault - Package Maven Plugin" />
diff --git a/vault-doc/README.md b/vault-doc/README.md
deleted file mode 100644
index b4f2678..0000000
--- a/vault-doc/README.md
+++ /dev/null
@@ -1,48 +0,0 @@
-<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
- -->
-
-FileVault Documentation
-=======================
-The FileVault documentation lives as Markdown files in `src/site/markdown` such
-that it easy to view e.g. from GitHub. Alternatively the Maven site plugin
-can be used to build and deploy a web site as follows:
-
-1. From the reactor build the site with javadoc:
-
- ````
- $ mvn site
- ````
-
-2. Review the site at `vault-doc/target/site`
-
-3. Deploy the site to `http://jackrabbit.apache.org/filevault/` using:
-
- ````
- $ cd vault-doc
- $ mvn site-deploy
- ````
-
-4. Finally review the site at `http://jackrabbit.apache.org/filevault/index.html`.
-
-
-Note: To skip the final commit use `-Dscmpublish.skipCheckin=true`. You can then
-review all pending changes in `vault-doc/target/scmpublish-checkout` and follow
-up with `svn commit` manually.
-
-Note: Every committer should be able to deploy the site. No fiddling with
-credentials needed since deployment is done via svn commit to
-`https://svn.apache.org/repos/asf/jackrabbit/site/live/filevault`.
diff --git a/vault-doc/pom.xml b/vault-doc/pom.xml
deleted file mode 100644
index 09689b7..0000000
--- a/vault-doc/pom.xml
+++ /dev/null
@@ -1,132 +0,0 @@
-<?xml version="1.0"?><!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
--->
-<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/maven-v4_0_0.xsd ">
- <modelVersion>4.0.0</modelVersion>
- <!-- ====================================================================== -->
- <!-- P A R E N T P R O J E C T D E S C R I P T I O N -->
- <!-- ====================================================================== -->
- <parent>
- <groupId>org.apache.jackrabbit.vault</groupId>
- <artifactId>parent</artifactId>
- <relativePath>../parent/pom.xml</relativePath>
- <version>3.4.11-SNAPSHOT</version>
- </parent>
-
- <!-- ====================================================================== -->
- <!-- P R O J E C T D E S C R I P T I O N -->
- <!-- ====================================================================== -->
- <artifactId>vault-doc</artifactId>
- <version>3.4.11-SNAPSHOT</version>
- <packaging>jar</packaging>
-
- <name>Apache Jackrabbit FileVault Documentation</name>
-
- <!-- ====================================================================== -->
- <!-- B U I L D -->
- <!-- ====================================================================== -->
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-site-plugin</artifactId>
- <configuration>
- <generateReports>true</generateReports>
- <skip>false</skip>
- <relativizeDecorationLinks>false</relativizeDecorationLinks>
- </configuration>
- </plugin>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-scm-publish-plugin</artifactId>
- <executions>
- <execution>
- <id>scm-publish</id>
- <phase>site-deploy</phase>
- <goals>
- <goal>publish-scm</goal>
- </goals>
- </execution>
- </executions>
- <configuration>
- <content>target/site</content>
- <checkinComment>@trivial: Site checkin for project ${project.name}-${project.version}
- </checkinComment>
- <ignorePathsToDelete>
- <ignorePathToDelete>apidocs</ignorePathToDelete>
- </ignorePathsToDelete>
- </configuration>
- </plugin>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-resources-plugin</artifactId>
- <executions>
- <execution>
- <phase>pre-site</phase>
- <goals>
- <goal>resources</goal>
- </goals>
- </execution>
- </executions>
- <configuration>
- <outputDirectory>${project.build.directory}/site</outputDirectory>
- </configuration>
- </plugin>
- </plugins>
-
- <resources>
- <resource>
- <directory>src/site/markdown</directory>
- <includes>
- <include>*.png</include>
- <include>*.jpg</include>
- <include>*.jpeg</include>
- <include>*.gif</include>
- </includes>
- </resource>
- </resources>
- </build>
-
- <reporting>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-project-info-reports-plugin</artifactId>
- <reportSets>
- <reportSet>
- <reports>
- <report>index</report>
- <report>team</report>
- <report>mailing-lists</report>
- <report>ci-management</report>
- <report>issue-management</report>
- <report>licenses</report>
- <report>scm</report>
- <report>distribution-management</report>
- </reports>
- </reportSet>
- </reportSets>
- </plugin>
- </plugins>
- </reporting>
-
- <distributionManagement>
- <site>
- <id>jackrabbit.filevault.site-deploy</id>
- <url>scm:svn:https://svn.apache.org/repos/asf/jackrabbit/site/live/filevault</url>
- </site>
- </distributionManagement>
-</project>