Dependency-Track Documentation

Documentation for OWASP Dependency-Track, built with MkDocs Material and organized per the Diataxis framework.

Prerequisites

• uv
• Make
• Docker or Podman (linters only)

Getting started

# Live-reload dev server on http://localhost:8000
make serve

# Production build
make build

Documentation structure

docs/
  tutorials/   # Learning-oriented walkthroughs
  guides/      # Task-oriented procedures
  concepts/    # Understanding-oriented background
  reference/   # Information-oriented technical descriptions
  blog/        # Release notes, changelog, engineering posts

Navigation is managed via .pages files in each section directory.

Linting

make lint              # Run all linters
make lint-markdown     # Markdown (markdownlint)
make lint-prose        # Prose quality (Vale)
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.

Generated documentation

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 hyades-apiserver	update-config-docs	make generate-config-docs APISERVER_PROPERTIES=<path>
Protobuf schemas	.proto files in hyades-apiserver	update-proto-docs	make generate-proto-docs APISERVER_DIR=<path>
OpenAPI specs	CI artifacts from hyades-apiserver	update-openapi-docs	n/a