https://github.com/trento-project/docs
Trento project documentation repository
https://github.com/trento-project/docs
best-practices coding-standards docs templates
Last synced: about 2 months ago
JSON representation
Trento project documentation repository
- Host: GitHub
- URL: https://github.com/trento-project/docs
- Owner: trento-project
- License: other
- Created: 2022-11-11T08:43:27.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2026-02-05T15:24:32.000Z (2 months ago)
- Last Synced: 2026-02-05T19:44:49.901Z (2 months ago)
- Topics: best-practices, coding-standards, docs, templates
- Language: CSS
- Homepage: https://trento-project.io/docs
- Size: 4.43 MB
- Stars: 4
- Watchers: 6
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.adoc
- License: LICENSE
Awesome Lists containing this project
README
= Developer Documentation
ifndef::site-gen-antora[:relfileprefix: /content/]
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 link:https://github.com/trento-project/docs/tree/main/content[*content* directory] is the home of these sources.
* xref:architecture/trento-architecture.adoc[Architecture]
* xref:architecture/adr/README.adoc[Architecture Decision Records (ADR)]
* xref:coding-standards/README.adoc[Coding standards]
* link:https://github.com/trento-project/docs/tree/main/content/rfc[Request for Comments (RFC)]
* link:https://github.com/trento-project/docs/tree/main/content/internal-notes[Internal Notes]
* link:https://github.com/trento-project/docs/tree/main/content/templates[Templates]
== Trento docs site
The `trento-docs-site` directory builds the link:https://www.trento-project.io/docs/[Trento project’s unified documentation site] using https://antora.org/[Antora]. Learn more about xref:trento-docs-site/README.adoc[the documentation hub here].
== Trento docs site ui
The `trento-docs-site-ui` directory is used to customize and design the layout of the link:https://www.trento-project.io/docs/[Trento docs site]. Learn more about the xref:trento-docs-site-ui/README.adoc[ui customization here].
== Trento docs hub preview
From the repository root, build the docs site and serve it on port 3000:
[source,bash]
----
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:
[source,bash]
----
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:
[source,bash]
----
docker compose up
----
== Dev docs environment without logs
Start all services in the background and skip compose logs:
[source,bash]
----
sudo bash dev-docs-env.sh
----
Once it finishes, open:
* http://localhost:3000 (Trento docs hub)
* http://localhost:3001 (SUSE HTML build)
* http://localhost:3002/SLES-SAP-trento_en.pdf (SUSE PDF build)