https://github.com/apache/db-jdo-site
Apache JDO project
https://github.com/apache/db-jdo-site
apache api database db java jdo jpa jta nosql orm
Last synced: about 1 year ago
JSON representation
Apache JDO project
- Host: GitHub
- URL: https://github.com/apache/db-jdo-site
- Owner: apache
- License: apache-2.0
- Created: 2019-04-26T01:14:24.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2025-04-08T18:53:24.000Z (about 1 year ago)
- Last Synced: 2025-04-10T11:58:46.951Z (about 1 year ago)
- Topics: apache, api, database, db, java, jdo, jpa, jta, nosql, orm
- Language: HTML
- Homepage: https://db.apache.org/jdo
- Size: 26.3 MB
- Stars: 3
- Watchers: 6
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# JDO Website
This repository contains the sources for the [Apache DB JDO website](https://db.apache.org/jdo/).
## Building the Site
The content and styling of the site is defined in the [AsciiDoc](https://asciidoc.org/) format.
It is built using [Maven](https://maven.apache.org/).
For details on publishing the site see section [Publishing the Site](#publishing-the-site).
The site can be built by calling `mvn clean compile`. This generates the HTML files in `target/site`.
Most of the site will work with the exception of the javadoc file downloads.
If needed, call `mvn package`. This copies the javadoc files to `target/site`.
The site can then be viewed by opening the local file `target/site/index.html` in a browser.
### 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 the following command in the api submodule: `mvn clean install -Papache-release`.
* Create a new folder in the javadoc resources directory e.g. `src/main/resources/javadoc/api32`.
* Copy the javadocs jar into the new folder, e.g. `cp jdo-api-3.2-javadoc.jar src/main/resources/javadoc/api32`.
* Create a new subfolder, e.g. `src/main/resources/javadoc/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](https://db.apache.org/jdo/get-involved.html) 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`.
* Additional pre-compiled resources are located in `src/main/resources`.
Contributions to this repository follow the default [GitHub workflow](https://guides.github.com/introduction/flow/)
using [forks](https://guides.github.com/activities/forking/).
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](#building-the-site)) 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.
### Reporting issues
If you find any issues please provide a PR or [create a JIRA ticket](https://issues.apache.org/jira/projects/JDO/issues/?filter=allopenissues).
### 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-jdo-site/.github/workflows/deploy-site.yml`](./.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/jdo`. 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](https://cwiki.apache.org/confluence/display/INFRA/git+-+.asf.yaml+features#git.asf.yamlfeatures-WebSiteDeploymentServiceforGitRepositories).