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 2020/06/05 15:03:30 UTC
[jackrabbit-filevault] branch master updated: releng: clean up site
This is an automated email from the ASF dual-hosted git repository.
kwin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/jackrabbit-filevault.git
The following commit(s) were added to refs/heads/master by this push:
new 87e54c6 releng: clean up site
87e54c6 is described below
commit 87e54c68478b8445c3bb339b6bfde3a6d2e47f64
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Fri Jun 5 17:03:14 2020 +0200
releng: clean up site
prepare for inheritance
add logo & breadcrumb
---
README.md | 3 ++
parent/pom.xml | 68 +++++++++++++--------------
parent/src/site/site.xml | 57 ++++++++++++++++++++++
pom.xml | 1 -
vault-doc/src/site/markdown/docview.md | 5 ++
vault-doc/src/site/markdown/filter.md | 2 +
vault-doc/src/site/markdown/howto_release.md | 2 +
vault-doc/src/site/markdown/importmode.md | 2 +
vault-doc/src/site/markdown/overview.md | 2 +
vault-doc/src/site/markdown/properties.md | 2 +
vault-doc/src/site/markdown/rcp.md | 2 +
vault-doc/src/site/markdown/usage.md | 2 +
vault-doc/src/site/markdown/validation.md | 2 +
vault-doc/src/site/markdown/vaultfs.md | 2 +
vault-doc/src/site/resources/asf_logo.png | Bin 0 -> 14186 bytes
vault-doc/src/site/resources/favicon.ico | Bin 0 -> 3638 bytes
vault-doc/src/site/resources/jackrabbit.png | Bin 0 -> 13921 bytes
vault-doc/src/site/site.xml | 14 +-----
18 files changed, 118 insertions(+), 48 deletions(-)
diff --git a/README.md b/README.md
index e1eb5ec..2e0d622 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,6 @@
+[](https://issues.apache.org/jira/projects/JCRVLT/summary)
+
+[](https://search.maven.org/artifact//org.apache.jackrabbit.vault/vault-cli)
[](https://travis-ci.org/apache/jackrabbit-filevault)
Welcome to Apache Jackrabbit FileVault
diff --git a/parent/pom.xml b/parent/pom.xml
index d99de48..7db6b7a 100644
--- a/parent/pom.xml
+++ b/parent/pom.xml
@@ -14,20 +14,22 @@
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 " child.project.url.inherit.append.path="false">
+<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 "
+ child.project.url.inherit.append.path="false">
<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 -->
+ <!-- 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</groupId>
<artifactId>apache</artifactId>
<version>23</version>
- <relativePath />
+ <relativePath/>
</parent>
<!-- ====================================================================== -->
- <!-- P R O J E C T D E S C R I P T I O N -->
+ <!-- P R O J E C T D E S C R I P T I O N -->
<!-- ====================================================================== -->
<groupId>org.apache.jackrabbit.vault</groupId>
<artifactId>parent</artifactId>
@@ -47,6 +49,7 @@ Apache Jackrabbit FileVault is a project of the Apache Software Foundation.
</description>
<properties>
+ <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<jackrabbit.version>2.20.0</jackrabbit.version>
<oak.version>1.26.0</oak.version>
<slf4j.version>1.7.6</slf4j.version>
@@ -54,31 +57,34 @@ Apache Jackrabbit FileVault is a project of the Apache Software Foundation.
<test.vm.options>-Doak=$test.oak}</test.vm.options>
<argLine>${test.vm.options}</argLine>
<java.target.version>1.8</java.target.version>
- <bnd.version>5.0.1</bnd.version>
+ <bnd.version>5.1.0</bnd.version>
<maven.version>3.6.1</maven.version><!-- due to https://issues.apache.org/jira/browse/MNG-6059 -->
+ <surefire.version>3.0.0-M4</surefire.version>
</properties>
<!-- ====================================================================== -->
- <!-- S C M D E F I N I T I O N -->
+ <!-- S C M D E F I N I T I O N -->
<!-- ====================================================================== -->
<!-- using adjusted inheritance rules: https://issues.apache.org/jira/browse/MNG-6059 -->
- <scm child.scm.connection.inherit.append.path="false"
- child.scm.developerConnection.inherit.append.path="false"
- child.scm.url.inherit.append.path="true">
+ <scm child.scm.connection.inherit.append.path="false" child.scm.developerConnection.inherit.append.path="false"
+ child.scm.url.inherit.append.path="true">
<connection>scm:git:https://gitbox.apache.org/repos/asf/jackrabbit-filevault.git</connection>
<developerConnection>scm:git:https://gitbox.apache.org/repos/asf/jackrabbit-filevault.git</developerConnection>
<url>https://github.com/apache/jackrabbit-filevault/tree/${project.scm.tag}</url>
<tag>trunk</tag>
</scm>
- <mailingLists>
+ <!-- ====================================================================== -->
+ <!-- P R O J E C T I N F O -->
+ <!-- ====================================================================== -->
+ <mailingLists>
<mailingList>
<name>Jackrabbit Developer List</name>
<subscribe>dev-subscribe@jackrabbit.apache.org</subscribe>
<unsubscribe>dev-unsubscribe@jackrabbit.apache.org</unsubscribe>
<post>mailto:dev@jackrabbit.apache.org</post>
- <archive>http://mail-archives.apache.org/mod_mbox/jackrabbit-dev/</archive>
+ <archive>https://lists.apache.org/list.html?dev@jackrabbit.apache.org</archive>
</mailingList>
<mailingList>
@@ -86,9 +92,8 @@ Apache Jackrabbit FileVault is a project of the Apache Software Foundation.
<subscribe>users-subscribe@jackrabbit.apache.org</subscribe>
<unsubscribe>users-unsubscribe@jackrabbit.apache.org</unsubscribe>
<post>mailto:users@jackrabbit.apache.org</post>
- <archive>http://mail-archives.apache.org/mod_mbox/jackrabbit-users/</archive>
+ <archive>https://lists.apache.org/list.html?users@jackrabbit.apache.org</archive>
</mailingList>
-
</mailingLists>
<issueManagement>
@@ -102,13 +107,13 @@ Apache Jackrabbit FileVault is a project of the Apache Software Foundation.
</ciManagement>
<!-- ====================================================================== -->
- <!-- B U I L D D E F I N I T I O N -->
+ <!-- B U I L D D E F I N I T I O N -->
<!-- ====================================================================== -->
<build>
<pluginManagement>
<plugins>
<!-- ====================================================================== -->
- <!-- S L I N G P L U G I N -->
+ <!-- S L I N G P L U G I N -->
<!-- ====================================================================== -->
<plugin>
<groupId>org.apache.sling</groupId>
@@ -185,12 +190,11 @@ Bundle-Category: jackrabbit
</configuration>
</plugin>
<!-- ====================================================================== -->
- <!-- S U R E F I R E P L U G I N -->
+ <!-- S U R E F I R E P L U G I N -->
<!-- ====================================================================== -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
- <version>3.0.0-M4</version>
<configuration>
<systemProperties>
<property>
@@ -202,7 +206,7 @@ Bundle-Category: jackrabbit
</configuration>
</plugin>
<!-- ====================================================================== -->
- <!-- R E L E A S E P L U G I N -->
+ <!-- R E L E A S E P L U G I N -->
<!-- ====================================================================== -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -217,10 +221,16 @@ Bundle-Category: jackrabbit
<artifactId>maven-release-oddeven-policy</artifactId>
<version>3.0.0-M1</version>
</dependency>
+ <!-- https://issues.apache.org/jira/browse/MRELEASE-1040 -->
+ <dependency>
+ <groupId>org.eclipse.aether</groupId>
+ <artifactId>aether-util</artifactId>
+ <version>1.0.0.v20140518</version>
+ </dependency>
</dependencies>
</plugin>
<!-- ====================================================================== -->
- <!-- R A T P L U G I N -->
+ <!-- R A T P L U G I N -->
<!-- ====================================================================== -->
<plugin>
<groupId>org.apache.rat</groupId>
@@ -240,16 +250,12 @@ Bundle-Category: jackrabbit
</configuration>
</plugin>
<!-- ====================================================================== -->
- <!-- S I T E P L U G I N -->
+ <!-- S I T E P L U G I N -->
<!-- ====================================================================== -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<version>3.9.0</version>
- <configuration>
- <skip>true</skip>
- <skipDeploy>true</skipDeploy>
- </configuration>
<dependencies>
<dependency>
<groupId>org.apache.maven.doxia</groupId>
@@ -265,11 +271,6 @@ Bundle-Category: jackrabbit
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-scm-publish-plugin</artifactId>
- <version>3.0.0</version>
- </plugin>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.1.1</version>
</plugin>
@@ -289,12 +290,11 @@ Bundle-Category: jackrabbit
<version>${java.target.version}</version>
</requireJavaVersion>
<requireMavenVersion>
- <version>${maven.version}</version>
+ <version>${maven.version}</version>
</requireMavenVersion>
</rules>
</configuration>
</execution>
- <execution>enforce</execution>
</executions>
</plugin>
</plugins>
@@ -322,7 +322,7 @@ Bundle-Category: jackrabbit
<artifactId>maven-enforcer-plugin</artifactId>
</plugin>
</plugins>
-
+
</build>
<!-- ====================================================================== -->
@@ -340,7 +340,7 @@ Bundle-Category: jackrabbit
</reporting>
<!-- ====================================================================== -->
- <!-- D E P E N D E N C Y M A N A G E M E N T -->
+ <!-- D E P E N D E N C Y M A N A G E M E N T -->
<!-- ====================================================================== -->
<dependencyManagement>
<dependencies>
@@ -538,7 +538,7 @@ Bundle-Category: jackrabbit
<profiles>
<profile>
<!-- ====================================================================== -->
- <!-- R A T P L U G I N -->
+ <!-- R A T P L U G I N -->
<!-- ====================================================================== -->
<id>rat-check</id>
<activation>
diff --git a/parent/src/site/site.xml b/parent/src/site/site.xml
new file mode 100644
index 0000000..e72b833
--- /dev/null
+++ b/parent/src/site/site.xml
@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ 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/DECORATION/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 http://maven.apache.org/xsd/decoration-1.8.0.xsd"
+ name="Jackrabbit FileVault Package Maven Plugin">
+ <publishDate position="right"/>
+ <version position="right"/>
+ <bannerLeft>
+ <name>Apache Jackrabbit</name>
+ <src>./jackrabbit.png</src>
+ <href>https://jackrabbit.apache.org/</href>
+ </bannerLeft>
+ <bannerRight>
+ <name>Apache</name>
+ <src>./asf_logo.png</src>
+ <href>https://apache.org/</href>
+ </bannerRight>
+ <edit>${project.scm.url}</edit>
+ <body>
+ <breadcrumbs>
+ <item name="Jackrabbit" href="http://jackrabbit.apache.org/"/>
+ <item name="Jackrabbit FileVault" href="http://jackrabbit.apache.org/filevault/" />
+ </breadcrumbs>
+ </body>
+
+ <skin>
+ <groupId>org.apache.maven.skins</groupId>
+ <artifactId>maven-fluido-skin</artifactId>
+ <version>1.9</version>
+ </skin>
+
+ <custom>
+ <fluidoSkin>
+ <sourceLineNumbersEnabled>true</sourceLineNumbersEnabled>
+ <topBarEnabled>true</topBarEnabled>
+ <sideBarEnabled>true</sideBarEnabled>
+ <googleSearch/>
+ </fluidoSkin>
+ </custom>
+</project>
diff --git a/pom.xml b/pom.xml
index 59403a7..4c5f4c0 100644
--- a/pom.xml
+++ b/pom.xml
@@ -108,7 +108,6 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>2.7</version>
</plugin>
</plugins>
</reporting>
diff --git a/vault-doc/src/site/markdown/docview.md b/vault-doc/src/site/markdown/docview.md
index 4ac0219..a1a2dcd 100644
--- a/vault-doc/src/site/markdown/docview.md
+++ b/vault-doc/src/site/markdown/docview.md
@@ -18,6 +18,11 @@
FileVault DocView
=================
+<!-- MACRO{toc} -->
+
+Overview
+----------
+
FileVault uses a slightly different version of the Document View specified by [JCR 2.0][jcr-docview].
In general all nodes can cannot be serialized as plain directories or as plain files are either
serialized into DocView XML file. If the node can only be partially mapped to a directory or file,
diff --git a/vault-doc/src/site/markdown/filter.md b/vault-doc/src/site/markdown/filter.md
index f48133f..05f8da4 100644
--- a/vault-doc/src/site/markdown/filter.md
+++ b/vault-doc/src/site/markdown/filter.md
@@ -22,6 +22,8 @@ the `META-INF/vault` directory. The `filter.xml` is used to load and initialize
the [WorkspaceFilter][api.WorkspaceFilter]. The workspace filter defines what parts of the JCR repository are
imported or exported during the respective operations through `vlt` or package management.
+<!-- MACRO{toc} -->
+
General Structure
-----------------
The `filter.xml` consists of a set of `filter` elements, each with a mandatory `root` attribute and an optional list of
diff --git a/vault-doc/src/site/markdown/howto_release.md b/vault-doc/src/site/markdown/howto_release.md
index 6f5eb25..6004cc1 100644
--- a/vault-doc/src/site/markdown/howto_release.md
+++ b/vault-doc/src/site/markdown/howto_release.md
@@ -19,6 +19,8 @@ How To Create A Release
========================================================================================================================
<!-- line width set to 120 characters. please break lines so that this file also looks good in vi -->
+<!-- MACRO{toc} -->
+
Prerequisites for release managers
----------------------------------
You need to be a Jackrabbit committer to prepare and perform a release, but anyone is welcome to help test the release
diff --git a/vault-doc/src/site/markdown/importmode.md b/vault-doc/src/site/markdown/importmode.md
index 0682a6d..f138b3a 100644
--- a/vault-doc/src/site/markdown/importmode.md
+++ b/vault-doc/src/site/markdown/importmode.md
@@ -19,6 +19,8 @@ Import Mode
===========
The import mode defines how importing content is applied to existing content in the repository. It is controlled by the [ImportOptions][api.ImportOptions] and the [WorkspaceFilter][api.WorkspaceFilter] and defaults to `REPLACE`.
+<!-- MACRO{toc} -->
+
Modes
-----
It is important to note, that the import mode always operates on entire nodes and subtrees, and never just on properties (with an exception of the group membership). For example an `ImportMode.MERGE` does **not** merge the properties from an existing node with those of the package.
diff --git a/vault-doc/src/site/markdown/overview.md b/vault-doc/src/site/markdown/overview.md
index 8ca14fd..e33df2d 100644
--- a/vault-doc/src/site/markdown/overview.md
+++ b/vault-doc/src/site/markdown/overview.md
@@ -30,6 +30,8 @@ The base of the Jackrabbit FileVault is the [VaultFs](vaultfs.html) which provid
+<!-- MACRO{toc} -->
+
How it works
------------
Jackrabbit FileVault works similar to subversion. Usually you checkout a local copy of the (partial) content of the repository and make modifications to it. Once you're finished you upload the modified stuff again. The content is mapped to a local filesystem structure using the VaultFs API. The mechanism works like Subversion where you have a copy of the unmodified file and some information about the entries.
diff --git a/vault-doc/src/site/markdown/properties.md b/vault-doc/src/site/markdown/properties.md
index f46a23b..fc95ece 100644
--- a/vault-doc/src/site/markdown/properties.md
+++ b/vault-doc/src/site/markdown/properties.md
@@ -22,6 +22,8 @@ the `META-INF/vault` directory. It defines defines several meta data around the
which are just used for informational purpose (like `lastModifiedBy`) and other properties which actually influence how the package
is installed (like `subPackageHandling`). In addition to that there is the `MANIFEST.MF` within `META-INF` which contains only informational metadata.
+<!-- MACRO{toc} -->
+
properties.xml
-----------------
The `properties.xml` follows the format of a Java properties file in XML format as defined by [java.util.Properties](https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html). The individual keys are defined within [PackageProperties][api.PackageProperties].
diff --git a/vault-doc/src/site/markdown/rcp.md b/vault-doc/src/site/markdown/rcp.md
index 6129b3c..4bea4a5 100644
--- a/vault-doc/src/site/markdown/rcp.md
+++ b/vault-doc/src/site/markdown/rcp.md
@@ -15,11 +15,13 @@
limitations under the License.
-->
+
Vault Remote Copy (rcp)
=======================
Jackrabbit vault offers a simple method to copy nodes between repositories.
+<!-- MACRO{toc} -->
Commandline Mode
----------------
diff --git a/vault-doc/src/site/markdown/usage.md b/vault-doc/src/site/markdown/usage.md
index d850241..65dcbb5 100644
--- a/vault-doc/src/site/markdown/usage.md
+++ b/vault-doc/src/site/markdown/usage.md
@@ -21,6 +21,8 @@ Usage
**NOTE**: Parts of the following documentation is outdated and needs review
- - -
+<!-- MACRO{toc} -->
+
Vault Console Tool
------------------
The console tool is called `vlt` and has the following usage:
diff --git a/vault-doc/src/site/markdown/validation.md b/vault-doc/src/site/markdown/validation.md
index 0c10853..cd206ab 100644
--- a/vault-doc/src/site/markdown/validation.md
+++ b/vault-doc/src/site/markdown/validation.md
@@ -17,6 +17,8 @@
-->
# Validation
+<!-- MACRO{toc} -->
+
## Overview
The artifact `org.apache.jackrabbit.vault:vault-validation` provides both an API for validating FileVault packages as well as an SPI for implementing validators. In addition this JAR contains useful validators.
diff --git a/vault-doc/src/site/markdown/vaultfs.md b/vault-doc/src/site/markdown/vaultfs.md
index 23d3715..e13b6a5 100644
--- a/vault-doc/src/site/markdown/vaultfs.md
+++ b/vault-doc/src/site/markdown/vaultfs.md
@@ -20,6 +20,8 @@ Vault FS
**NOTE**: Parts of the following documentation is outdated and needs review
- - -
+<!-- MACRO{toc} -->
+
Introduction
------------
we see in various applications the need for a simple jcr repository to filesystem mapping. for example in source management tools, fileserver bindings, import/export stuff etc. if a jcr repository would only consist of `nt:file` and `nt:folder`, this would be easy. but if other nodetypes are used (even a simple as extending from `nt:file`) the mapping to the filesystem is not so trivial anymore. the idea is to provide a general all-purpose mechanism to export to and import from a standar [...]
diff --git a/vault-doc/src/site/resources/asf_logo.png b/vault-doc/src/site/resources/asf_logo.png
new file mode 100644
index 0000000..94f91cf
Binary files /dev/null and b/vault-doc/src/site/resources/asf_logo.png differ
diff --git a/vault-doc/src/site/resources/favicon.ico b/vault-doc/src/site/resources/favicon.ico
new file mode 100644
index 0000000..6f05b3b
Binary files /dev/null and b/vault-doc/src/site/resources/favicon.ico differ
diff --git a/vault-doc/src/site/resources/jackrabbit.png b/vault-doc/src/site/resources/jackrabbit.png
new file mode 100644
index 0000000..bacda55
Binary files /dev/null and b/vault-doc/src/site/resources/jackrabbit.png differ
diff --git a/vault-doc/src/site/site.xml b/vault-doc/src/site/site.xml
index 86c9efb..6f678c9 100644
--- a/vault-doc/src/site/site.xml
+++ b/vault-doc/src/site/site.xml
@@ -21,8 +21,6 @@
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.3.0 http://maven.apache.org/xsd/decoration-1.3.0.xsd"
name="Jackrabbit Filevault">
- <edit>${project.scm.url}</edit>
-
<body>
<menu name="Overview">
<item href="index.html" name="Jackrabbit FileVault" />
@@ -54,22 +52,12 @@
<menu ref="modules"/>
<menu ref="reports" inherit="bottom"/>
<menu name="Links">
- <item href="https://jackrabbit.apache.org/" name="Apache Jackrabbit" />
<item href="https://jackrabbit.apache.org/filevault-package-maven-plugin" name="Apache Jackrabbit FileVault - Package Maven Plugin" />
</menu>
</body>
- <skin>
- <groupId>org.apache.maven.skins</groupId>
- <artifactId>maven-fluido-skin</artifactId>
- <version>1.9</version>
- </skin>
-
<custom>
<fluidoSkin>
- <sourceLineNumbersEnabled>true</sourceLineNumbersEnabled>
- <topBarEnabled>true</topBarEnabled>
- <sideBarEnabled>true</sideBarEnabled>
<gitHub>
<projectId>apache/jackrabbit-filevault</projectId>
<ribbonOrientation>right</ribbonOrientation>
@@ -77,7 +65,7 @@
<ohloh>
<projectId>jackrabbit-filevault</projectId>
</ohloh>
- <googlePlusOne />
+ <googleSearch/>
</fluidoSkin>
</custom>
</project>