This repository contains the source files that are used to build the Jakarta Enterprise Edition (Jakarta EE) Tutorial. The source files are authored in AsciiDoc. AsciiDoc is similar to markdown but is particularly suited for user documentation. This project also uses JBake. JBake is a static site generator that is inspired from Jekyll and written in Java. JBake uses templates for the structure of the page and the body of the page is generated from AsciiDoc content.
Note that the Jakarta EE Tutorial code examples are located in a separate repository eclipse-ee4j/jakartaee-tutorial-examples.
The easiest way to contribute is by opening an issue in this project that contains feedback and review comments.
The Jakarta EE Tutorial project is also open for contributions and your help is greatly appreciated. If you have an idea for the tutorial and want to add a section or update an existing section, then review the following links:
The following directions explain how to do local builds of the tutorial. Note that any changes that are pushed to the master branch automatically trigger a build of the site files and tutorial sources. The results are automatically pushed to the gh-pages branch. You can view the published site here.
- Maven
- JDK8+
Note that manually deploying the site requires password-less authentication. This is done by exporting your SSH public key into your GitHub account.
The site is generated under target/staging. Open
file:///PATH_TO_PROJECT_DIR/target/staging in a browser to view the
output.
mvn generate-resources
You can also invoke the JBake plugin directly:
mvn jbake:build
The following command builds the site and, if kept running, detects changes to the sources and incrementally renders the site. This is convenient when writing content.
mvn jbake:watch
If a web server is required (for example, absolute paths are used), you
can use the following command to start a Jetty web server at
http://localhost:8820. The command also watches for changes and
rebuilds incrementally.
mvn jbake:serve
If you want to manually push a build to the gh-pages branch, use:
mvn deploy -Ppublish-site
Never commit changes to the gh-pages branch directly.
To produce a zip file containing the generated HTML files, use:
mvn package
When making a release on GitHub, this zip file should be added to the release.