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. The source files are processed and integrated into the Jakarta EE Documentation site using Antora, which is a tool for building documentation sites.
You can always find the most recent build of the Jakarta EE Documentation site here: https://jakartaee.github.io/jakartaee-documentation/.
We keep the source files (VSD) and the published format (SVG)
for images in the src/main/antora/modules/common/images folder.
However, currently all the source file names don't match their corresponding SVG file.
If you modify a source image,
please help us out and rename it to match the output image.
Guidelines for generating new images can be found in the Contributing guide.
The contents of this repo are built by the jakartaee-documentation repository. See that repo for details.
- eclipse-ee4j/jakartaee-examples - Contains examples used in the tutorial (and additional examples)
- jakartaee/jakartaee-documentation - builds documentation site
- jakartaee/jakartaee-documentation-ui - HTML and CSS assets used for the documentation site look and feel.
This project is open for contributions, and your help is greatly appreciated. The easiest way to contribute is by opening an issue in this project that contains feedback and review comments.
You can also create PRs directly while viewing the published documentation by using the Edit button in the UI.
If you want to keep up with our project planning across all of the repos, see the project board.
If you'd like to propose changes or additions to the content and/or images,
please read the Style guide and
Contributing guide for more information.
Join us on Slack in the #jakartaee-tutorial channel to discuss open issues and plan updates.