Google Git
Sign in
apache / db-site

Apache DB project

Mirrored from https://github.com/apache/db-site.git
Clone this repo:

Branches

  1. e3d630f Update link references from link:<name>.html to xref:<name>.adoc by Michael Bouschen · 2 years, 10 months ago main
  2. 7fb21d9 Mailing list update (#1) by Tilmann · 2 years, 10 months ago
  3. 01d3186 Update README.md by Tilmann · 2 years, 10 months ago
  4. bd2eaa7 Remove JDO Jira link from README by Tobias Bouschen · 2 years, 11 months ago
  5. cf9caf6 Update communication.adoc by Tilmann · 2 years, 11 months ago

Apache DB Website

This repository contains the sources for the Apache DB website.

Building the Site

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. The site can then be viewed by opening the local file target/site/index.html in a browser.

Contributing to the Site

Contributions to the website are always appreciated. If you are new to this project, please have a look at our mailing lists page first.

This repository contains the Apache DB website source.

  • The AsciiDoc sources can be found in src/main/asciidoc.
  • The website menu is defined in src/main/template.
  • Additional pre-compiled resources are located in src/main/resources.

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.
  • Build the site (see above) and verify the generated website by viewing target/site/index.html locally with a web browser.
  • Commit the source changes (not the build artifacts) in your branch and open a pull request.

Publishing the Site

After changes have been made to the sources in the src/main/asciidoc or 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:

  1. Pushing changes to the main branch invokes the post-push script in db-site/.github/workflows/deploy-site.yml which builds the site in target/site via mvn clean package.

  2. If the build is successful, the build artifacts in the main branch are pushed to the publish branch.

  3. 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/. 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.