Skip to content

Commit 6641e0b

Browse files
committed
Update repo links in README
Also adds status badges. Signed-off-by: nscuro <nscuro@protonmail.com>
1 parent c2a13bf commit 6641e0b

1 file changed

Lines changed: 16 additions & 5 deletions

File tree

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
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.
66

7+
[![Build status](https://github.com/DependencyTrack/docs/actions/workflows/build.yml/badge.svg)](https://github.com/DependencyTrack/docs/actions/workflows/build.yml)
8+
[![Deploy status](https://github.com/DependencyTrack/docs/actions/workflows/deploy.yml/badge.svg)](https://github.com/DependencyTrack/docs/actions/workflows/deploy.yml)
9+
710
## Prerequisites
811

912
- [uv](https://docs.astral.sh/uv/)
@@ -50,8 +53,16 @@ Linters run in Docker, except for Python which uses [Ruff](https://docs.astral.s
5053

5154
Some reference pages are generated from upstream source repositories and should not be edited directly. GitHub Actions workflows are provided to automate regeneration.
5255

53-
| Content | Source | Workflow | Local command |
54-
|:--------|:-------|:---------|:--------------|
55-
| Configuration properties | `application.properties` in [hyades-apiserver](https://github.com/DependencyTrack/hyades-apiserver) | `update-config-docs` | `make generate-config-docs APISERVER_PROPERTIES=<path>` |
56-
| Protobuf schemas | `.proto` files in [hyades-apiserver](https://github.com/DependencyTrack/hyades-apiserver) | `update-proto-docs` | `make generate-proto-docs APISERVER_DIR=<path>` |
57-
| OpenAPI specs | CI artifacts from [hyades-apiserver](https://github.com/DependencyTrack/hyades-apiserver) | `update-openapi-docs` | n/a |
56+
| Content | Source | Workflow | Local command |
57+
|:--------|:----------------------------------------------------------------------------------------------------|:---------|:--------------|
58+
| Configuration properties | `application.properties` in [dependency-track](https://github.com/DependencyTrack/dependency-track) | `update-config-docs` | `make generate-config-docs APISERVER_PROPERTIES=<path>` |
59+
| Protobuf schemas | `.proto` files in [dependency-track](https://github.com/DependencyTrack/dependency-track) | `update-proto-docs` | `make generate-proto-docs APISERVER_DIR=<path>` |
60+
| OpenAPI specs | CI artifacts from [dependency-track](https://github.com/DependencyTrack/dependency-track) | `update-openapi-docs` | n/a |
61+
62+
## See also
63+
64+
* [dependency-track](https://github.com/DependencyTrack/dependency-track): Main repository
65+
* [frontend](https://github.com/DependencyTrack/frontend): Frontend repository
66+
* [helm-charts](https://github.com/DependencyTrack/helm-charts): [Helm](https://helm.sh/) charts
67+
* [community](https://github.com/DependencyTrack/community): Community resources
68+

0 commit comments

Comments
 (0)