mkdocs.yml

site_name: Hyades
site_url: https://dependencytrack.github.io/hyades/latest/

repo_name: DependencyTrack/hyades
repo_url: https://github.com/DependencyTrack/hyades

docs_dir: docs
edit_uri: blob/main/docs/

theme:
  name: material
  palette:
  - scheme: default
    media: "(prefers-color-scheme: light)"
    toggle:
      icon: material/brightness-7
      name: Switch to dark mode
  - scheme: slate
    media: "(prefers-color-scheme: dark)"
    toggle:
      icon: material/brightness-4
      name: Switch to light mode
  features:
  - content.action.edit
  - content.code.copy
  - content.code.select
  - navigation.instant
  - navigation.tracking
  - navigation.tabs
  - navigation.tabs.sticky
  - navigation.top
  - search.highlight
  - search.share
  - toc.integrate

extra:
  version:
    provider: mike
  social:
  - icon: fontawesome/brands/slack
    link: https://dependencytrack.org/slack
  - icon: fontawesome/brands/github
    link: https://github.com/DependencyTrack
  - icon: fontawesome/brands/docker
    link: https://hub.docker.com/u/dependencytrack
  - icon: fontawesome/brands/twitter
    link: https://twitter.com/DependencyTrack

markdown_extensions:
- attr_list
- admonition
- def_list
- footnotes
- md_in_html
- pymdownx.details
- pymdownx.emoji:
    emoji_index: !!python/name:material.extensions.emoji.twemoji
    emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
    anchor_linenums: true
    line_spans: __span
    pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences:
    custom_fences:
      - name: mermaid
        class: mermaid
        format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
    alternate_style: true
- tables
- toc:
    permalink: true
    toc_depth: 3

plugins:
- search
- social

nav:
- Getting Started:
    - Overview: index.md
    - Quick Start: getting-started/quickstart.md
    - Changes over v4: getting-started/changes-over-v4.md
    - Migrating from v4: getting-started/migrating-from-v4.md
    - Upgrading: getting-started/upgrading.md
- Usage:
    - Policy Compliance:
        - Overview: usage/policy-compliance/overview.md
        - Expressions: usage/policy-compliance/expressions.md
        - Vulnerability Policies: usage/policy-compliance/vulnerability-policies.md
    - Notifications:
        - Overview: usage/notifications/overview.md
        - Publishers: usage/notifications/publishers.md
        - Filter Expressions: usage/notifications/filter-expressions.md
        - Templating: usage/notifications/templating.md
- Architecture:
    - Overview: architecture/index.md
    - Decisions:
        - Overview: architecture/decisions/000-index.md
        - "ADR-001: Drop Kafka Dependency": architecture/decisions/001-drop-kafka-dependency.md
        - "ADR-002: Workflow Orchestration": architecture/decisions/002-workflow-orchestration.md
        - "ADR-003: Notification Publishing": architecture/decisions/003-notification-publishing.md
        - "ADR-004: File Storage Plugin": architecture/decisions/004-file-storage-plugin.md
        - "ADR-005: Materialize Project Hierarchies": architecture/decisions/005-materialize-project-hierarchies.md
        - "ADR-006: Consolidate User Tables": architecture/decisions/006-consolidate-user-tables.md
        - "ADR-007: Spec-First REST API v2": architecture/decisions/007-spec-first-rest-api-v2.md
        - "ADR-009: Auth And Roles": architecture/decisions/009-auth-and-roles.md
        - "ADR-010: Vulnerability Datasource Extension Point": architecture/decisions/010-vulnerability-datasource-extension-point.md
        - "ADR-011: Notification Outbox": architecture/decisions/011-notification-outbox.md
        - "ADR-012: Extension KV Store": architecture/decisions/012-extension-kv-store.md
        - "ADR-013: Finding Status": architecture/decisions/013-finding-status.md
        - "ADR-014: New Alias Schema": architecture/decisions/014-new-alias-schema.md
        - "ADR-015: Package Metadata": architecture/decisions/015-package-metadata.md
        - "ADR-016: User-Managed Vulnerability Policies": architecture/decisions/016-user-managed-vuln-policies.md
        - "ADR-017: Notification Filter Expressions": architecture/decisions/017-notification-filter-expressions.md
    - Design:
        - Durable Execution: architecture/design/durable-execution.md
        - Notifications: architecture/design/notifications.md
        - Package Metadata Resolution: architecture/design/package-metadata-resolution.md
        - Vulnerability Analysis: architecture/design/vulnerability-analysis.md
        - Archive:
            - Workflow State Tracking: architecture/design/archive/workflow-state-tracking.md
- Operations:
    - Configuration:
        - Overview: operations/configuration/overview.md
        - Data Sources: operations/configuration/datasources.md
        - File Storage: operations/configuration/file-storage.md
    - Database: operations/database.md
    - Observability: operations/observability.md
    - Secret Management:
        - Overview: operations/secret-management/overview.md
        - Providers: operations/secret-management/providers.md
    - Scaling: operations/scaling.md
- Development:
  - Overview: development/overview.md
  - Building: development/building.md
  - Testing: development/testing.md
  - Database Migrations: development/database-migrations.md
  - Durable Execution: development/durable-execution.md
  - Documentation: development/documentation.md
- Reference:
    - Configuration:
        - API Server: reference/configuration/api-server.md
    - Schemas:
        - Notification: reference/schemas/notification.md
        - Policy: reference/schemas/policy.md