diff --git a/README.md b/README.md index 54f9310..d2eb140 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,9 @@ Documentation for [OWASP Dependency-Track](https://dependencytrack.org), built with [MkDocs Material](https://squidfunk.github.io/mkdocs-material/) and organized per the [Diataxis](https://diataxis.fr/) framework. +[![Build status](https://github.com/DependencyTrack/docs/actions/workflows/build.yml/badge.svg)](https://github.com/DependencyTrack/docs/actions/workflows/build.yml) +[![Deploy status](https://github.com/DependencyTrack/docs/actions/workflows/deploy.yml/badge.svg)](https://github.com/DependencyTrack/docs/actions/workflows/deploy.yml) + ## Prerequisites - [uv](https://docs.astral.sh/uv/) @@ -50,8 +53,16 @@ Linters run in Docker, except for Python which uses [Ruff](https://docs.astral.s 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](https://github.com/DependencyTrack/hyades-apiserver) | `update-config-docs` | `make generate-config-docs APISERVER_PROPERTIES=` | -| Protobuf schemas | `.proto` files in [hyades-apiserver](https://github.com/DependencyTrack/hyades-apiserver) | `update-proto-docs` | `make generate-proto-docs APISERVER_DIR=` | -| OpenAPI specs | CI artifacts from [hyades-apiserver](https://github.com/DependencyTrack/hyades-apiserver) | `update-openapi-docs` | n/a | +| Content | Source | Workflow | Local command | +|:--------|:----------------------------------------------------------------------------------------------------|:---------|:--------------| +| Configuration properties | `application.properties` in [dependency-track](https://github.com/DependencyTrack/dependency-track) | `update-config-docs` | `make generate-config-docs APISERVER_PROPERTIES=` | +| Protobuf schemas | `.proto` files in [dependency-track](https://github.com/DependencyTrack/dependency-track) | `update-proto-docs` | `make generate-proto-docs APISERVER_DIR=` | +| OpenAPI specs | CI artifacts from [dependency-track](https://github.com/DependencyTrack/dependency-track) | `update-openapi-docs` | n/a | + +## See also + +- [dependency-track](https://github.com/DependencyTrack/dependency-track): Main repository +- [frontend](https://github.com/DependencyTrack/frontend): Frontend repository +- [helm-charts](https://github.com/DependencyTrack/helm-charts): [Helm](https://helm.sh/) charts +- [community](https://github.com/DependencyTrack/community): Community resources +