https://github.com/apache/jackrabbit-site

Apache Jackrabbit Website
https://github.com/apache/jackrabbit-site

database jackrabbit java jcr repository

Last synced: 1 day ago
JSON representation

Apache Jackrabbit Website

• Host: GitHub
• URL: https://github.com/apache/jackrabbit-site
• Owner: apache
• Created: 2024-01-14T14:19:01.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-09-12T12:01:40.000Z (13 days ago)
• Last Synced: 2024-09-20T21:33:04.967Z (5 days ago)
• Topics: database, jackrabbit, java, jcr, repository
• Language: CSS
• Homepage: https://jackrabbit.apache.org/
• Size: 35.1 MB
• Stars: 1
• Watchers: 15
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


Jackrabbit Site Generation

==========================

[![Apache License, Version 2.0, January 2004](https://img.shields.io/github/license/apache/maven.svg?label=License)][license]

[![Jenkins Status](https://img.shields.io/jenkins/s/https/ci-builds.apache.org/job/Jackrabbit/job/jackrabbit-site/job/main.svg)][build]

This is the Git repository for the content of . 

Further information in [website](src/site/markdown/website.md).

The Jackrabbit site lives as Markdown files in `src/site/markdown` such

that it easy to view e.g. from GitHub. This project only generates the

content below , otherwise

the scm-publish mechanism is too slow, checking out the entire site.

The Maven site plugin is used to build the web site as follows:

1. In this project's directory execute:

   ````

   $ mvn site

   ````

2. Review the site at `target/site/index.html`

3. Commit and push your changes to the source files

### Automatic Deployment

The `main` branch is automatically built on the [ASF Jenkins][build] after every commit and the results are automatically committed to  from where the Website is being populated.

### Manual Deployment

1. Build and deploy the site to  using:

   ````

   $ mvn site-deploy

   ````

2. Finally review the site at .

Note: To skip the final commit use `-Dscmpublish.skipCheckin=true`. You can then

review all pending changes in `target/scmpublish-checkout` and follow

up with `svn commit` manually.

Note: Every committer should be able to deploy the site. Deployment is done via svn commit to

`https://svn.apache.org/repos/asf/jackrabbit/site/live/jcr`. 

The credentials are retrieved from a server with `id` *apache.releases.https* from the [Maven Settings](https://maven.apache.org/settings.html). Alternatively

one can provide the credentials explicitly via `-Dpassword` and `-Dusername` ([maven-scm-publish-plugin:publish-scm](https://maven.apache.org/plugins/maven-scm-publish-plugin/publish-scm-mojo.html)).

[jira]: https://issues.apache.org/jira/projects/JCRSITE/

[license]: https://www.apache.org/licenses/LICENSE-2.0

[build]: https://ci-builds.apache.org/job/Jackrabbit/job/jackrabbit-site/job/main/