Google Git
Sign in
apache / db-jdo-site / 2db41a0cd314a995c24a69f844fc170f50f2bc98
commit2db41a0cd314a995c24a69f844fc170f50f2bc98[log] [tgz]
authorTobias Bouschen <tobias.bouschen@googlemail.com>Wed Jul 22 22:09:17 2020 +0200
committerGitHub <noreply@github.com>Wed Jul 22 22:09:17 2020 +0200
tree0f045164fac8a1f91b368bb3835c95c3cb26e553
parent15f6aa74e303362e686782b403a9c5462cab0c8c [diff]
Update contribution guidelines (#7)

* Rework README

Restructures the readme to make it easier to read and find the necessary
information.

Drops the instructions on how to use git. If the potential contributor
does not know how to use it, this readme is not the place for them to
learn it.

Removes the entry on committing the generated site artifacts. This
should be done separately to keep the pull requests clean.

Adds links to GitHub resources explaining the basic GitHub workflow.

* Add CONTRIBUTING page

This page will be linked to whenever a new PR is created. It just points
the user to the README and the "Getting Involved" page on the website.

* Update "Get Involved" page

Restructures the sections to make information easier to find.

Adds more information on how to contribute using GitHub.

Adds a section about the need for the Apache Contributor License
Agreement.

Links back to the "Get Involved" page from the "Source Code" page.
4 files changed
tree: 0f045164fac8a1f91b368bb3835c95c3cb26e553
  1. .github/
  2. docs/
  3. src/
  4. content ⇨ docs
  5. .asf.yaml
  6. .gitattributes
  7. .gitignore
  8. .htaccess
  9. CONTRIBUTING.md
  10. LICENSE.txt
  11. pom.xml
  12. 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