Add notification documentation#32
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
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
glightboxplugin 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.
Signed-off-by: nscuro <nscuro@protonmail.com>
b432c5b to
19641a3
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.