Skip to content

Add notification documentation#32

Merged
nscuro merged 1 commit into
mainfrom
notification-docs
Apr 27, 2026
Merged

Add notification documentation#32
nscuro merged 1 commit into
mainfrom
notification-docs

Conversation

@nscuro
Copy link
Copy Markdown
Member

@nscuro nscuro commented Apr 27, 2026

No description provided.

Copilot AI review requested due to automatic review settings April 27, 2026 20:33
@nscuro nscuro added the enhancement New feature or request label Apr 27, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR expands the documentation set around Dependency-Track notifications (alerts, publishers, filtering, templates) and updates site configuration/assets to support the new pages and screenshots.

Changes:

  • Add new notifications docs (tutorial, user/administration guides, and reference pages) and wire them into navigation.
  • Standardize/relocate many screenshots to docs/assets/images/... and adjust image links across several pages.
  • Add the MkDocs glightbox plugin plus CSS tweaks to improve screenshot presentation.

Reviewed changes

Copilot reviewed 26 out of 62 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
uv.lock Adds mkdocs-glightbox and its dependency chain (incl. selectolax).
pyproject.toml Pins mkdocs-glightbox==0.5.1 for the docs build environment.
mkdocs.yml Enables the glightbox MkDocs plugin.
docs/tutorials/setting-up-notifications.md New tutorial walking through creating a console-backed alert and triggering BOM_PROCESSED.
docs/tutorials/.pages Adds quick start + notifications tutorial to tutorials navigation.
docs/stylesheets/extra.css Adds consistent styling for raster images (borders/shadows, slate background tweak).
docs/reference/notifications/templating.md New reference page describing template context variables, filters, and restrictions.
docs/reference/notifications/publishers.md Adds SSRF/local-connection restrictions section and updates screenshot paths + wording.
docs/reference/notifications/groups.md Refines group descriptions/headings and adds a group→subject mapping table.
docs/reference/notifications/filter-expressions.md Reworks filter expression docs and updates screenshots/links to the new “how filtering works” section.
docs/reference/notifications/.pages Adds “Templating” to notifications reference navigation.
docs/reference/analyzers.md Updates analyzer screenshot paths to the docs/assets/images/... layout.
docs/images/reference/expression-condition.png Included asset in the PR (used for docs imagery).
docs/guides/user/managing-vulnerability-policies.md Updates guide screenshot paths to the new asset layout.
docs/guides/user/managing-secrets.md Updates guide screenshot paths to the new asset layout.
docs/guides/user/configuring-notifications.md New user guide for creating and scoping notification alerts (projects/tags/schedules/filters).
docs/guides/user/.pages Adds “configuring notifications” to user guide navigation.
docs/guides/administration/migrating-from-v4.md Updates migration guide screenshot paths to the new asset layout.
docs/guides/administration/managing-notification-templates.md New admin guide for cloning/editing/deleting notification templates.
docs/guides/administration/debugging-notifications.md New admin guide describing common delivery failures and log-based diagnosis.
docs/guides/administration/configuring-database.md Updates PGTune screenshot path to the new asset layout.
docs/guides/administration/.pages Adds the new notification admin guides to administration navigation.
docs/concepts/time-series-metrics.md Updates screenshot path to the new asset layout.
docs/concepts/notifications.md Refreshes notifications concepts; adds explicit “how alert filtering works” ordering + fail-open behavior.
docs/concepts/architecture/design/notifications.md Improves wording/clarity for outbox emission/relay/publishing sections.
docs/assets/images/tutorials/setting-up-notifications/login.png New tutorial screenshot.
docs/assets/images/tutorials/setting-up-notifications/create-alert.png New tutorial screenshot.
docs/assets/images/reference/notifications/publishers/jira-publisher-global-config.png Adds/updates a reference screenshot asset.
docs/assets/images/guides/user/managing-secrets/use-secret.png Adds/updates a guide screenshot asset.
docs/assets/images/guides/user/managing-secrets/delete-secret.png Adds/updates a guide screenshot asset.
context/vocabulary.md Adds/clarifies canonical terminology for publishers vs notification templates.
AGENTS.md Documents the “assets/images mirrors docs tree” convention.
.vale/styles/config/vocabularies/DependencyTrack/accept.txt Adds accepted terms needed by the new docs (e.g., loopback, crontab, misconfigured).

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

Comment thread docs/reference/notifications/groups.md Outdated
Comment thread docs/guides/administration/managing-notification-templates.md Outdated
Comment thread docs/guides/administration/managing-notification-templates.md Outdated
Comment thread docs/reference/notifications/groups.md Outdated
Signed-off-by: nscuro <nscuro@protonmail.com>
@nscuro nscuro force-pushed the notification-docs branch from b432c5b to 19641a3 Compare April 27, 2026 20:57
@nscuro nscuro merged commit 416144d into main Apr 27, 2026
5 checks passed
@nscuro nscuro deleted the notification-docs branch April 27, 2026 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants