Apache JDO project

Clone this repo:
  1. 17a5ffd Move copy-resources from compile to prepare-package maven lifecycle phase by Michael Bouschen · 7 days ago master
  2. 6653958 Add site build workflow for pull requests by Tobias Bouschen · 8 days ago
  3. bf25aef Simplify workflow branch rule by Tobias Bouschen · 8 days ago
  4. e1119e7 Use icons with highest resolution available for website by Tobias Bouschen · 12 days ago
  5. 49ba8be Mention automatic JIRA linking as part of the "Get Involved" page by Tobias Bouschen · 3 weeks ago

JDO Website

This repository contains the sources for the Apache DB JDO website.

Building the Site

The content and styling of the site is defined in the AsciiDoc format. It is built using Maven.

The site can be built by calling mvn clean compile. This generates the HTML files in target/site.

Adding Javadoc

The site contains a packaged version of the JDO API javadoc. It can be updated as follows:

  • Create the javadoc jar (e.g. jdo-api-3.2-javadoc.jar) in the db-jdo repository by calling mvn clean install -Papache-release in the api submodule.
  • Create a new folder under docs e.g. docs/api32.
  • Copy the javadocs jar info the new folder: e.g. cp jdo-api-3.2-javadoc.jar docs/api32.
  • Create a new subfolder docs/api32/jdo-api-3.2-javadoc
  • Unpack the javadoc jar in the subfolder
  • Edit javadoc.adoc under src/main/asciidoc and create a new section ‘JDO 3.2 javadoc’.
  • Add two links: one referring index.html in the subfolder and one referring the javadoc jar.

Contributing to the Site

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.

  • The AsciiDoc sources can be found in src/main/asciidoc.
  • The website menu is defined in src/main/template.
  • The converter for migrating the old HTML files to AsciiDoc can be found in src/main/java

Contributions to this repository follow the default GitHub workflow using forks.

To contribute changes, you can follow these steps:

  • Adapt the AsciiDoc files in src/main/asciidoc or the website menu in src/main/template.
  • Call mvn clean compile to build the site and verify the generated website by viewing it locally with a web browser.
  • Commit the source changes (not the build artifacts) and open a pull request.