Migrate reference documentation

[nscuro]

Migrates the existing reference documentation from https://github.com/DependencyTrack/hyades/tree/0.7.0-alpha.3/docs/, adjusting it for the new Diataxis structure.

[Copilot]

Pull request overview

Migrates and expands Dependency-Track’s reference documentation into a Diataxis-style structure, adding substantial new reference content (configuration, datasources, notifications, analyzers, schemas) and linking it to new/updated concepts and guides.

Changes:

• Added new reference pages for configuration, datasources, notifications (publishers + CEL filter expressions), vulnerability analyzers/policies, badges, file formats, and community integrations.
• Added schema reference pages (notification/policy) and API reference wrappers (Swagger UI pages) plus navigation (.pages) updates throughout the docs.
• Updated guides/concepts to align with the new reference structure and cross-linking; adjusted linting configs to ignore generated reference artifacts.

Reviewed changes

Copilot reviewed 50 out of 74 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
docs/reference/index.md	Replaces placeholder with a structured reference landing page and cross-links.
docs/reference/.pages	Adds Diataxis-oriented navigation structure for Reference.
docs/reference/vulnerability-policies.md	Adds full reference doc for vulnerability policies incl. bundle format/sync behavior.
docs/concepts/vulnerability-policies.md	Adds conceptual explanation and rationale (vs VEX) with links to guide/reference.
docs/guides/user/managing-vulnerability-policies.md	Adds procedural user guide for creating/editing/bundles.
docs/reference/cel-expressions.md	Adds CEL syntax/context/function reference and examples.
docs/reference/notifications/filter-expressions.md	Adds CEL-based notification filter expressions reference (new).
docs/reference/notifications/publishers.md	Documents notification publishers and their configuration UIs.
docs/reference/notifications/.pages	Adds navigation for notification reference subsection.
docs/reference/schemas/notification.md	Adds generated notification schema reference.
docs/reference/schemas/policy.md	Adds generated policy schema reference.
docs/reference/schemas/.pages	Adds navigation for schema reference subsection.
docs/reference/permissions.md	Replaces placeholder with permissions + default teams overview.
docs/concepts/access-control.md	Adds conceptual overview of users/teams/ACLs with links to guides.
docs/concepts/.pages	Adds concepts nav entries for access control and vulnerability policies.
docs/reference/analyzers.md	Adds reference documentation for built-in analyzers and options.
docs/reference/datasources/index.md	Adds datasources overview page and relationship to internal analyzer.
docs/reference/datasources/nvd.md	Adds NVD datasource reference page.
docs/reference/datasources/github-advisories.md	Adds GitHub Advisories datasource reference page.
docs/reference/datasources/osv.md	Adds OSV datasource reference page.
docs/reference/datasources/private-vulnerability-repository.md	Adds reference for private vulnerability repository behavior/fields.
docs/reference/datasources/repositories.md	Adds reference for package repository integration configuration and behavior.
docs/reference/datasources/internal-components.md	Adds reference for internal component matching and effects.
docs/reference/datasources/.pages	Adds navigation for datasources reference subsection.
docs/reference/configuration/application.md	Adds MicroProfile Config source order, expressions, env var mapping docs.
docs/reference/configuration/datasources.md	Adds datasource property format + pooling properties reference.
docs/reference/configuration/file-storage.md	Adds file storage provider docs (local + S3) and property links.
docs/reference/configuration/database.md	Adds PostgreSQL requirements/extensions/tuning + schema migration notes.
docs/reference/configuration/dex-engine.md	Adds durable execution engine worker/queue reference and defaults.
docs/reference/configuration/.pages	Adds navigation for configuration reference subsection.
docs/guides/administration/configuring-database.md	Adds operational guide for choosing/hosting/tuning PostgreSQL + pooling.
docs/guides/administration/scaling.md	Updates scaling guide to reference new dex/db/datasource docs.
docs/guides/administration/configuring-observability.md	Expands observability guide with Kubernetes probes + Prometheus scraping + logging.
docs/guides/administration/configuring-secret-management.md	Refines secret-management explanation (envelope encryption + keyset handling).
docs/guides/administration/configuring-ldap.md	Removes duplicated “how it works” section (now covered in concepts).
docs/guides/administration/configuring-oidc.md	Removes duplicated “how it works” section (now covered in concepts).
docs/guides/administration/.pages	Adds database guide to nav and reorders entries.
docs/guides/user/managing-private-vulnerabilities.md	Adds minimal guide page with link to reference.
docs/guides/user/.pages	Adds new user guide pages to navigation.
docs/reference/file-formats.md	Adds reference for CycloneDX support and Finding Packaging Format (FPF).
docs/reference/badges.md	Adds reference for badge endpoints, embedding, and required permissions.
docs/reference/community-integrations.md	Adds curated list of community integrations and clients.
docs/reference/api/v1.md	Adds Swagger UI embed page for REST API v1.
docs/reference/api/v2.md	Adds Swagger UI embed page for REST API v2.
docs/reference/api/.pages	Adds nav entries for REST API v1/v2 reference pages.
docs/guides/upgrading/v0.7.0.md	Fixes/updates doc links related to logging and schema migration credentials.
docs/reference/notifications/images/jira-publisher-global-config.png	Adds screenshot asset for publisher docs.
docs/guides/user/images/managing-vulnerability-policies/vuln-policies_bundles-modal.png	Adds screenshot asset for vulnerability policy bundles UI.
.yamllint.yml	Ignores API YAML files under docs/reference/api.
.vale.ini	Disables Vale styles for generated reference pages (properties + schemas).
.vale/styles/config/vocabularies/DependencyTrack/accept.txt	Extends vocabulary for repo-specific terms (but includes a typo).
.markdownlint-cli2.yaml	Ignores generated reference markdown (properties + schemas).

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.