Skip to content

Update repo links in README #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nscuro merged 2 commits into from
Jun 2, 2026
Merged

Update repo links in README #121

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6641e0b
Update repo links in README
nscuro Jun 2, 2026
561264f
Potential fix for pull request finding
nscuro Jun 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
Expand Down Expand Up @@ -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=<path>` |
| Protobuf schemas | `.proto` files in [hyades-apiserver](https://github.com/DependencyTrack/hyades-apiserver) | `update-proto-docs` | `make generate-proto-docs APISERVER_DIR=<path>` |
| 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=<path>` |
| Protobuf schemas | `.proto` files in [dependency-track](https://github.com/DependencyTrack/dependency-track) | `update-proto-docs` | `make generate-proto-docs APISERVER_DIR=<path>` |
| 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