This repository contains the sources for the Apache DB JDO website.
The content and styling of the site is defined in the AsciiDoc format. It is built using Maven. For details on publishing the site see section Publishing the Site.
The site can be built by calling
mvn clean compile. This generates the HTML files in
target/site. Most of the site will work with the exception of the javadoc file downloads. If needed, call
mvn package. This copies the javadoc files to
target/site. The site can then be viewed by opening the local file
target/site/index.html in a browser.
The site contains a packaged version of the JDO API javadoc. It can be updated as follows:
mvn clean install -Papache-release.
cp jdo-api-3.2-javadoc.jar src/main/resources/javadoc/api32.
Contributions to the website are always appreciated. If you are new to this project, please have a look at our Get Involved page first.
This repository contains the JDO website source.
Contributions to this repository follow the default GitHub workflow using forks.
To contribute changes, you can follow these steps:
src/main/asciidocor the website menu in
target/site/index.htmllocally with a web browser.
If you find any issues please provide a PR or create a JIRA ticket.
After changes have been made to the sources in the
src/main/template directory, changes will be published automatically to the live web site by simply pushing changes to the main branch of the repository. The process is as follows:
Pushing changes to the main branch invokes the post-push script in
db-jdo-site/.github/workflows/deploy-site.yml which builds the site in
mvn clean package.
If the build is successful, the build artifacts in the main branch are pushed to the
Once the changes have been pushed to the
publish branch, the script in
.asf.yaml.publish is automatically invoked. This script is executed by Apache Infrastructure machines, and it publishes changes to
db.apache.org/jdo. It may take some time for the changes to be seen on the live site. Details on the use of .asf.yaml is found here.