Google Git
Sign in
apache / db-jdo-site / 744aa969ace551e05fce9e6fc84c09572dfff2b0
commit744aa969ace551e05fce9e6fc84c09572dfff2b0[log] [tgz]
authorTobias Bouschen <tobias.bouschen@googlemail.com>Sat Jan 23 01:06:16 2021 +0100
committerTobias Bouschen <tobias.bouschen@googlemail.com>Thu Jan 28 20:28:29 2021 +0100
tree641d3da91257e12ac870b2229f828127de1c9739
parent383fdc8457aae67b028a22782755180ff8d21d1e [diff]
Add recovery workflow to recreate the site branch

Adds a workflow to recreate the site branch in case it ever gets deleted
on accident or becomes corrupted.

The new workflow to automatically deploy the site relies on there being
a functioning site branch. This workflow offers an recovery option to
recreate a stable version of the site branch with which the deploy
workflow can function.

The workflow does not listen for any events on the repository. It can
only be triggered manually. To do so, go to the "Actions" section of the
GitHub page for the repository and select the action from the menu. At
the top of the list of past workflow runs is a blue bar offering the
option to "Run workflow". Select the option and press the green button
"Run workflow".

When running the workflow, the default selection to run it on the master
branch should not be changed. Even though the workflow is explicitly
configured to check out the master branch, running the action on a
different branch might still have other unintended side effects.
1 file changed
tree: 641d3da91257e12ac870b2229f828127de1c9739
  1. .github/
  2. docs/
  3. src/
  4. content ⇨ docs
  5. .asf.yaml
  6. .asf.yaml.publish
  7. .gitattributes
  8. .gitignore
  9. .htaccess
  10. CONTRIBUTING.md
  11. LICENSE.txt
  12. pom.xml
  13. README.md
README.md

JDO Website

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

The website is mirrored on https://apache.github.io/db-jdo-site/.

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