Documentation for OWASP Dependency-Track, built with MkDocs Material and organized per the Diataxis framework.
- uv
- Make
- Docker or Podman (linters only)
# Live-reload dev server on http://localhost:8000 make serve # Production build make build
docs/
tutorials/ # Learning-oriented walkthroughs
guides/ # Task-oriented procedures
concepts/ # Understanding-oriented background
reference/ # Information-oriented technical descriptions
Navigation is managed via .pages files in each section directory.
make lint # Run all linters make lint-markdown # Markdown (markdownlint) make lint-prose # Prose quality (Vale, full docs/ tree) make lint-prose-changed # Vale, only files changed vs. the upstream branch make lint-yaml # YAML (yamllint) make lint-python # Python (Ruff)
Linters run in Docker, except for Python which uses Ruff via uvx. Fix all errors before submitting changes.
Some reference pages are generated from upstream source repositories and should not be edited directly. GitHub Actions workflows are provided to automate regeneration.
| Content | Source | Workflow | Local command |
|---|---|---|---|
| Configuration properties | application.properties in dependency-track |
update-config-docs |
make generate-config-docs APISERVER_PROPERTIES=<path> |
| Protobuf schemas | .proto files in dependency-track |
update-proto-docs |
make generate-proto-docs APISERVER_DIR=<path> |
| OpenAPI specs | CI artifacts from dependency-track | update-openapi-docs |
n/a |
- dependency-track: Main repository
- frontend: Frontend repository
- helm-charts: Helm charts
- community: Community resources