mirror of
https://github.com/jeap-admin-ch/jeap-doc-service.git
synced 2026-08-26 10:34:20 +00:00
Read-only mirror of https://github.com/jeap-admin-ch/jeap-doc-service — Bundesamt für Informatik und Telekommunikation. Issues & pull requests at the source.
- Java 99.9%
- Shell 0.1%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| .mvn | ||
| docs | ||
| jeap-doc-domain | ||
| jeap-doc-objectstorage | ||
| jeap-doc-persistence | ||
| jeap-doc-service-instance | ||
| jeap-doc-web | ||
| .gitignore | ||
| AGENTS.md | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| mvnw | ||
| mvnw.cmd | ||
| pom.xml | ||
| publiccode.yml | ||
| README.md | ||
| SECURITY.md | ||
| setPomVersions.sh | ||
| THIRD-PARTY-LICENSES.md | ||
jEAP Doc Service
The jEAP Doc Service receives the documentation of systems, components and libraries, stores it on S3, generates the documentation site and serves it to the browser.
It is the central piece of the hybrid documentation approach: teams write their documentation as Markdown next to their code, their build pipelines upload it, and the doc service combines it with the architecture model of the jEAP Arch Repo Service into one generated site.
Documentation
| Topic | Contents |
|---|---|
| Getting started | Creating a doc service instance and running it locally |
| Architecture | The ports-and-adapters layout, the modules and the rules they follow |
| Configuration | The configuration properties, with their defaults |
| API | The REST API and its OpenAPI description |
| Uploads | What happens to an uploaded bundle, the state of an upload, and what a retry does |
| Security | The semantic roles and the rule that a system may only change its own documentation |
License
This repository is Open Source Software licensed under the Apache License 2.0.