|
4 | 4 |
|
5 | 5 | 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. |
6 | 6 |
|
| 7 | +[](https://github.com/DependencyTrack/docs/actions/workflows/build.yml) |
| 8 | +[](https://github.com/DependencyTrack/docs/actions/workflows/deploy.yml) |
| 9 | + |
7 | 10 | ## Prerequisites |
8 | 11 |
|
9 | 12 | - [uv](https://docs.astral.sh/uv/) |
@@ -50,8 +53,16 @@ Linters run in Docker, except for Python which uses [Ruff](https://docs.astral.s |
50 | 53 |
|
51 | 54 | Some reference pages are generated from upstream source repositories and should not be edited directly. GitHub Actions workflows are provided to automate regeneration. |
52 | 55 |
|
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