Developer Documentation

This repository contains the Trento project documentation that does not interest a specific service, such as ADR, coding standards and best practices, CI workflows, and templates. The content directory is the home of these sources.

• Architecture

• Architecture Decision Records (ADR)

• Coding standards

• Request for Comments (RFC)

• Internal Notes

• Templates

Trento docs site

The trento-docs-site directory builds the Trento project’s unified documentation site using Antora. Learn more about the documentation hub here.

Trento docs site ui

The trento-docs-site-ui directory is used to customize and design the layout of the Trento docs site. Learn more about the ui customization here.

Trento docs hub preview

From the repository root, build the docs site and serve it on port 3000:

docker compose up trento-docs

Open http://localhost:3000 while the command is running.

The generated HTML is in trento-docs-site/build/trento-docs-site-public.

Official SUSE documentation preview

From the repository root, build the DocBook HTML in a container and serve it on port 3001:

docker compose up daps-serve

Open http://localhost:3001 while the command is running.

The generated HTML is in trento/build/SLES-SAP-trento/html/SLES-SAP-trento. Each run clears trento/build/SLES-SAP-trento before rebuilding to avoid stale files.

Combined preview (Antora + DocBook)

Start both preview servers with one command:

docker compose up