1
0
mirror of synced 2025-12-21 19:06:49 -05:00

Reducing noise from notifications for Dependabot/security alerts (#16088)

* first stab

* fix issues with liquid tags

* applied a few fixes and improvements

* rewrite options

* rewrite for GHES 2.21

* fix liquid versioning (again)

* I love liquid tags

* swap paragraphs for GHES 2.21

* add link to new article in 2 existing articles

* started major rework to avoid info duplication

* part of the reorg work

* starting the major reorg

* fix syntax

* rework Configuring notifications article

* reorganizing again

* more reorg

* add new reusable

* fix typo

* add correct variable

* link to correct article for GHES < 2.21

* Update content/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies.md

Co-authored-by: Alex Mullans <infin8x@github.com>

* Apply suggestions from code review

Co-authored-by: Felicity Chapman <felicitymay@github.com>

* Update data/reusables/notifications/vulnerable-dependency-notification-options-detailed.md

Co-authored-by: Maya Kaczorowski <15946341+mayakacz@users.noreply.github.com>

* fix typo reported in #16036

* address comments from code review

* yet another commit

* polishing

* Update content/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies.md

Co-authored-by: Maya Kaczorowski <15946341+mayakacz@users.noreply.github.com>

* use variables

* address more comments

* add condition to link as linked article is free-pro-team only

* fix condition

* remove reusable that had duplicated content

* remove incorrect info

* fix issue in GHES article

* added shortTitle

* Apply suggestions from code review

Co-authored-by: Maya Kaczorowski <15946341+mayakacz@users.noreply.github.com>

* reword for clarity

* add more detail

Co-authored-by: Alex Mullans <infin8x@github.com>
Co-authored-by: Felicity Chapman <felicitymay@github.com>
Co-authored-by: Maya Kaczorowski <15946341+mayakacz@users.noreply.github.com>
This commit is contained in:
mc
2020-10-23 11:40:38 +01:00
committed by GitHub
parent 43061b0044
commit 53f8234b4e
9 changed files with 101 additions and 49 deletions

View File

@@ -163,25 +163,10 @@ If you are a member of more than one organization, you can configure each one to
### Security alert notification options
{% endif %}
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}Choose how you want to receive {% data variables.product.prodname_dependabot_alerts %} for repositories that you are watching. You can receive {% data variables.product.prodname_dependabot_alerts %} in your inbox, as a banner on {% data variables.product.product_name %}, on the command line, through email, or some combination of these options.
{% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization %}
{% data reusables.notifications.vulnerable-dependency-notification-options %}
If you want to receive {% data variables.product.prodname_dependabot_alerts %} by email, choose whether you want a weekly email summary of vulnerabilities for up 10 repositories or a new email each time a vulnerability is detected. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."{% endif %}
{% if currentVersion == "enterprise-server@2.21" %}Choose how you want to receive security alerts for repositories that you are watching. You can receive security alerts in your inbox, as a banner on {% data variables.product.product_name %}, on the command line, through email, or some combination of these options.
If you want to receive security alerts by email, choose whether you want a weekly email summary of vulnerabilities for up 10 repositories or a new email each time a vulnerability is detected. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."{% endif %}
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
![{% data variables.product.prodname_dependabot_short %} alerts options](/assets/images/help/notifications-v2/dependabot-alerts-options.png)
{% else %}
![Security alerts options](/assets/images/help/notifications-v2/security-alerts-options.png)
{% endif %}
{% note %}
**Note:** You can filter your {% data variables.product.company_short %} inbox notifications by {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_short %}{% else %} security{% endif %} alerts. For more information, see "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#supported-queries-for-custom-filters)."
{% endnote %}
For more information about the notification delivery methods available to you, and advice on optimizing your notifications for {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %}, see "[Configuring notifications for vulnerable dependencies](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies)."
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}

View File

@@ -124,6 +124,8 @@ To filter notifications for specific activity on {% data variables.product.produ
- `is:repository-advisory`
- `is:team-discussion`
For information about reducing noise from notifications for {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %}, see "[Configuring notifications for vulnerable dependencies](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies)."
You can also use the `is:` query to describe how the notification was triaged.
- `is:saved`

View File

@@ -38,7 +38,7 @@ When you unsubscribe from notifications in your inbox, they will automatically d
{% data reusables.notifications.access_notifications %}
1. From the notifications inbox, select the notifications you want to unsubscribe to.
2. Use the the **selected** {% octicon "triangle-down" aria-label="The down triangle icon" %} drop-down to click **Unsubscribe.**
2. Use the **selected** {% octicon "triangle-down" aria-label="The down triangle icon" %} drop-down to click **Unsubscribe.**
![Unsubcribe option from main inbox](/assets/images/help/notifications-v2/unsubscribe-from-main-inbox.png)
### Unsubscribing from notifications on the subscriptions page