This is the official documentation for the Eclipse Cargo Tracker project. The documentation uses AsciiDoc and Antora. The documentation is published at: https://jakarta.ee/learn/docs/cargotracker-documentation/current/index.html.

The documentation is organized as follows:

• Getting Started: Provides brief orientation on the project

• Visual Studio Code: Provides detailed instructions on how to get started with Visual Studio Code

• Jakarta EE and DDD: Provides a brief overview of DDD as it relates to this project and Jakarta EE

• Characterization: Overviews how the basic building blocks of the domain - entities, value objects, aggregates, services, repositories and factories - are implemented in the application using Jakarta EE

• Layers: Explains the architectural layers in the application and how they relate to various Jakarta EE APIs

• Resources: Provides some useful resources for learning more about DDD and Jakarta EE

We welcome contributions to improve and expand the Cargo Tracker documentation! Please follow the steps below to make your changes:

1. Fork the repository including this branch.
2. Make your changes.
3. Ensure that your changes adhere to the project's style and formatting guidelines.
4. The Cargo Tracker documentation is built using the Jakarta EE documentation playbook. Read through the README for the Jakarta EE documentation to understand how to build and test the Cargo Tracker documentation.
5. Submit a pull request to this branch with a clear description of your changes.