Mention automatic JIRA linking as part of the "Get Involved" page

Mentions the capability to automatically referencing a pull request in a
JIRA ticket by including a reference to the ticket in the pull request
title in the "Get Involved" section.

The wording was chosen carefully not to imply that this would actually
link the state of the two. As far as I can tell, merging the pull
request will not have any influence on the state of the referenced
ticket. If this is actually the case, the wording should be adjusted to
reflect the behavior.

Moved the links to the JDO JIRA to HTTPS.
1 file changed
tree: cde796a8c0747274a6796111c7730172aabac250
  1. .asf.yaml
  2. .asf.yaml.publish
  3. .gitattributes
  4. .github/
  5. .gitignore
  6. .htaccess
  7. CONTRIBUTING.md
  8. LICENSE.txt
  9. README.md
  10. pom.xml
  11. src/
README.md

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.

TODO