Skip to content

Commit

Permalink
chore: PC-13335 Update URLs to main alerting docs (#245)
Browse files Browse the repository at this point in the history
## Motivation

This PR updates all links to the alerting section in the main Nobl9
documentation site.

---------

Co-authored-by: bsski <swedrowskibartosz@gmail.com>
  • Loading branch information
labtom and BSski authored Jun 28, 2024
1 parent 6a5d891 commit e055d5a
Show file tree
Hide file tree
Showing 28 changed files with 206 additions and 76 deletions.
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The Nobl9 Provider delivers tools working with the Nobl9 API to create and manag

The Nobl9 Terraform Provider does not support the configuration of the following resources:
- [SLO Annotations](https://docs.nobl9.com/features/slo-annotations/)
- [Alert Silence](https://docs.nobl9.com/Alerting/Alert_silence/)
- [Alert Silence](https://docs.nobl9.com/alerting/alert-silence/)

## Configuration

Expand Down
4 changes: 2 additions & 2 deletions docs/resources/agent.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
page_title: "nobl9_agent Resource - terraform-provider-nobl9"
description: |-
Agent configuration | Nobl9 Documentation https://docs.nobl9.com/nobl9_agent
Agent configuration | Nobl9 Documentation https://docs.nobl9.com/nobl9-agent/
---

# nobl9_agent (Resource)
Expand All @@ -10,7 +10,7 @@ The Agent is a lightweight application that executes the queries defined for you

The Agent then sends your SLI metrics back to Nobl9 for processing and error budget calculation.

For more information, refer to [Agent configuration | Nobl9 Documentation](https://docs.nobl9.com/nobl9_agent)
For more information, refer to [Agent configuration | Nobl9 Documentation](https://docs.nobl9.com/nobl9-agent/)

## Example Usage

Expand Down
6 changes: 3 additions & 3 deletions docs/resources/alert_method_discord.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
page_title: "nobl9_alert_method_discord Resource - terraform-provider-nobl9"
subcategory: "Alert Methods"
description: |-
Discord Alert Method | Nobl9 Documentation https://docs.nobl9.com/Alerting/Alert_methods/discord
Discord Alert Method | Nobl9 Documentation https://docs.nobl9.com/alerting/alert-methods/discord
---

# nobl9_alert_method_discord (Resource)

The **Discord Alert Method** enables sending alerts through Discord to notify Nobl9 users whenever an incident is triggered.

For more details, refer to [Discord Alert Method | Nobl9 Documentation](https://docs.nobl9.com/Alerting/Alert_methods/discord).
For more details, refer to [Discord Alert Method | Nobl9 Documentation](https://docs.nobl9.com/alerting/alert-methods/discord).

## Example Usage

Expand Down Expand Up @@ -45,6 +45,6 @@ resource "nobl9_alert_method_discord" "this" {

## Useful Links

[Discord alerts configuration | Nobl9 Documentation](https://docs.nobl9.com/Alerting/Alert_methods/discord/)
[Discord alerts configuration | Nobl9 Documentation](https://docs.nobl9.com/alerting/alert-methods/discord/)

[Intro to webhooks | Discord Documentation](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks)
6 changes: 3 additions & 3 deletions docs/resources/alert_method_email.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
page_title: "nobl9_alert_method_email Resource - terraform-provider-nobl9"
subcategory: "Alert Methods"
description: |-
Email Alert Method | Nobl9 Documentation https://docs.nobl9.com/Alerting/Alert_methods/email-alert
Email Alert Method | Nobl9 Documentation https://docs.nobl9.com/alerting/alert-methods/email-alert
---

# nobl9_alert_method_email (Resource)

The **Email Alert Method** enables sending automated and customized alert messages to up to 30 different inboxes per alert to notify Nobl9 users whenever an incident is triggered.

For more details, refer to [Email Alert Method | Nobl9 Documentation](https://docs.nobl9.com/Alerting/Alert_methods/email-alert).
For more details, refer to [Email Alert Method | Nobl9 Documentation](https://docs.nobl9.com/alerting/alert-methods/email-alert).

## Example Usage

Expand Down Expand Up @@ -51,4 +51,4 @@ resource "nobl9_alert_method_email" "this" {

## Useful links

[Email alerts configuration | Nobl9 Documentation](https://docs.nobl9.com/Alerting/Alert_methods/email-alert)
[Email alerts configuration | Nobl9 Documentation](https://docs.nobl9.com/alerting/alert-methods/email-alert)
6 changes: 3 additions & 3 deletions docs/resources/alert_method_jira.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
page_title: "nobl9_alert_method_jira Resource - terraform-provider-nobl9"
subcategory: "Alert Methods"
description: |-
Jira Alert Method | Nobl9 Documentation https://docs.nobl9.com/Alerting/Alert_methods/jira
Jira Alert Method | Nobl9 Documentation https://docs.nobl9.com/alerting/alert-methods/jira
---

# nobl9_alert_method_jira (Resource)

The **Jira Alert Method** automatically opens a Jira issue to notify you whenever an incident is triggered.

For more details, refer to [Jira Alert Method | Nobl9 Documentation](https://docs.nobl9.com/Alerting/Alert_methods/jira).
For more details, refer to [Jira Alert Method | Nobl9 Documentation](https://docs.nobl9.com/alerting/alert-methods/jira).

## Example Usage

Expand Down Expand Up @@ -51,6 +51,6 @@ resource "nobl9_alert_method_jira" "this" {

## Useful Links

[Jira alerts configuration | Nobl9 Documentation](https://docs.nobl9.com/Alerting/Alert_methods/jira/)
[Jira alerts configuration | Nobl9 Documentation](https://docs.nobl9.com/alerting/alert-methods/jira/)

[Atlassian Accounts Documentation](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/)
6 changes: 3 additions & 3 deletions docs/resources/alert_method_msteams.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
page_title: "nobl9_alert_method_msteams Resource - terraform-provider-nobl9"
subcategory: "Alert Methods"
description: |-
MS Teams Alert Method | Nobl9 Documentation https://docs.nobl9.com/Alerting/Alert_methods/ms-teams
MS Teams Alert Method | Nobl9 Documentation https://docs.nobl9.com/alerting/alert-methods/ms-teams
---

# nobl9_alert_method_msteams (Resource)

The **MS Teams Alert Method** enables sending alerts through MS Teams to notify Nobl9 users whenever an incident is triggered.

For more details, refer to [MS Teams Alert Method | Nobl9 Documentation](https://docs.nobl9.com/Alerting/Alert_methods/ms-teams).
For more details, refer to [MS Teams Alert Method | Nobl9 Documentation](https://docs.nobl9.com/alerting/alert-methods/ms-teams).

## Example Usage

Expand Down Expand Up @@ -45,6 +45,6 @@ resource "nobl9_alert_method_msteams" "this" {

## Useful Links

[MS Teams alerts configuration | Nobl9 Documentation](https://docs.nobl9.com/Alerting/Alert_methods/msteams/)
[MS Teams alerts configuration | Nobl9 Documentation](https://docs.nobl9.com/alerting/alert-methods/msteams/)

[MS Teams webhooks | MS Teams Documentation](https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook)
10 changes: 5 additions & 5 deletions docs/resources/alert_method_opsgenie.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
page_title: "nobl9_alert_method_opsgenie Resource - terraform-provider-nobl9"
subcategory: "Alert Methods"
description: |-
OpsGenie Alert Method | Nobl9 Documentation https://docs.nobl9.com/Alerting/Alert_methods/opsgenie
OpsGenie Alert Method | Nobl9 Documentation https://docs.nobl9.com/alerting/alert-methods/opsgenie
---

# nobl9_alert_method_opsgenie (Resource)

The **OpsGenie Alert Method** enables triggering alerts through OpsGenie to notify whenever an incident is triggered.

For more details, refer to [OpsGenie Alert Method | Nobl9 Documentation](https://docs.nobl9.com/Alerting/Alert_methods/opsgenie).
For more details, refer to [OpsGenie Alert Method | Nobl9 Documentation](https://docs.nobl9.com/alerting/alert-methods/opsgenie).

## Example Usage

Expand All @@ -33,11 +33,11 @@ resource "nobl9_alert_method_opsgenie" "this" {

- `name` (String) Unique name of the resource, must conform to the naming convention from [DNS RFC1123](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names).
- `project` (String) Name of the Nobl9 project the resource sits in, must conform to the naming convention from [DNS RFC1123](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names).
- `url` (String) Opsgenie API URL. See [Nobl9 documentation](https://docs.nobl9.com/Alerting/Alert_methods/opsgenie#creating-opsgenie-api-key) for more details.
- `url` (String) Opsgenie API URL. See [Nobl9 documentation](https://docs.nobl9.com/alerting/alert-methods/opsgenie#creating-opsgenie-api-key) for more details.

### Optional

- `auth` (String, Sensitive) Opsgenie authentication credentials. See [Nobl9 documentation](https://docs.nobl9.com/Alerting/Alert_methods/opsgenie#authentication) for supported formats.
- `auth` (String, Sensitive) Opsgenie authentication credentials. See [Nobl9 documentation](https://docs.nobl9.com/alerting/alert-methods/opsgenie#authentication) for supported formats.
- `description` (String) Optional description of the resource. Here, you can add details about who is responsible for the integration (team/owner) or the purpose of creating it.
- `display_name` (String) User-friendly display name of the resource.

Expand All @@ -47,4 +47,4 @@ resource "nobl9_alert_method_opsgenie" "this" {

## Useful Links

[OpsGenie alerts configuration | Nobl9 Documentation](https://docs.nobl9.com/Alerting/Alert_methods/opsgenie/)
[OpsGenie alerts configuration | Nobl9 Documentation](https://docs.nobl9.com/alerting/alert-methods/opsgenie/)
6 changes: 3 additions & 3 deletions docs/resources/alert_method_pagerduty.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
page_title: "nobl9_alert_method_pagerduty Resource - terraform-provider-nobl9"
subcategory: "Alert Methods"
description: |-
PagerDuty Alert Method | Nobl9 Documentation https://docs.nobl9.com/Alerting/Alert_methods/pagerduty
PagerDuty Alert Method | Nobl9 Documentation https://docs.nobl9.com/alerting/alert-methods/pagerduty
---

# nobl9_alert_method_pagerduty (Resource)

The **PagerDuty Alert Method** enables triggering alerts through PagerDuty to notify Nobl9 users whenever an incident is triggered.

For more details, refer to [PagerDuty Alert Method | Nobl9 Documentation](https://docs.nobl9.com/Alerting/Alert_methods/pagerduty).
For more details, refer to [PagerDuty Alert Method | Nobl9 Documentation](https://docs.nobl9.com/alerting/alert-methods/pagerduty).

## Example Usage

Expand Down Expand Up @@ -56,4 +56,4 @@ Optional:

## Useful Links

[PagerDuty alerts configuration | Nobl9 Documentation](https://docs.nobl9.com/Alerting/Alert_methods/pagerduty/)
[PagerDuty alerts configuration | Nobl9 Documentation](https://docs.nobl9.com/alerting/alert-methods/pagerduty/)
10 changes: 5 additions & 5 deletions docs/resources/alert_method_servicenow.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
page_title: "nobl9_alert_method_servicenow Resource - terraform-provider-nobl9"
subcategory: "Alert Methods"
description: |-
ServiceNow Alert Method | Nobl9 Documentation https://docs.nobl9.com/Alerting/Alert_methods/servicenow
ServiceNow Alert Method | Nobl9 Documentation https://docs.nobl9.com/alerting/alert-methods/servicenow
---

# nobl9_alert_method_servicenow (Resource)

The **ServiceNow Alert Method** automatically opens an issue in your ServiceNow workflow to notify you whenever an incident is triggered.

-> **NOTE** To allow ServiceNow alerts to integrate with Nobl9, you need to set up an Access Control List (ACL) for your ServiceNow users. Refer to [Nobl9 documentation](https://docs.nobl9.com/Alerting/Alert_methods/servicenow) for more details.
-> **NOTE** To allow ServiceNow alerts to integrate with Nobl9, you need to set up an Access Control List (ACL) for your ServiceNow users. Refer to [Nobl9 documentation](https://docs.nobl9.com/alerting/alert-methods/servicenow) for more details.

For more details, refer to [ServiceNow Alert Method | Nobl9 Documentation](https://docs.nobl9.com/Alerting/Alert_methods/servicenow).
For more details, refer to [ServiceNow Alert Method | Nobl9 Documentation](https://docs.nobl9.com/alerting/alert-methods/servicenow).

## Example Usage

Expand All @@ -34,7 +34,7 @@ resource "nobl9_alert_method_servicenow" "this" {

### Required

- `instance_name` (String) ServiceNow InstanceName. For details see [Nobl9 documentation](https://docs.nobl9.com/Alerting/Alert_methods/servicenow#servicenow-credentials).
- `instance_name` (String) ServiceNow InstanceName. For details see [Nobl9 documentation](https://docs.nobl9.com/alerting/alert-methods/servicenow#servicenow-credentials).
- `name` (String) Unique name of the resource, must conform to the naming convention from [DNS RFC1123](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names).
- `project` (String) Name of the Nobl9 project the resource sits in, must conform to the naming convention from [DNS RFC1123](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names).
- `username` (String) ServiceNow username.
Expand All @@ -51,4 +51,4 @@ resource "nobl9_alert_method_servicenow" "this" {

## Useful Links

[ServiceNow alerts configuration | Nobl9 Documentation](https://docs.nobl9.com/Alerting/Alert_methods/servicenow/)
[ServiceNow alerts configuration | Nobl9 Documentation](https://docs.nobl9.com/alerting/alert-methods/servicenow/)
6 changes: 3 additions & 3 deletions docs/resources/alert_method_slack.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
page_title: "nobl9_alert_method_slack Resource - terraform-provider-nobl9"
subcategory: "Alert Methods"
description: |-
Slack Alert Method | Nobl9 Documentation https://docs.nobl9.com/Alerting/Alert_methods/slack
Slack Alert Method | Nobl9 Documentation https://docs.nobl9.com/alerting/alert-methods/slack
---

# nobl9_alert_method_slack (Resource)
Expand All @@ -11,7 +11,7 @@ The **Slack Alert Method** allows sending a predefined notification through Slac

-> **NOTE** To set up the Slack integration, you'll need to provide an Incoming Webhook URL. This allows Slack to send an automated notification to a channel of your choice. For details, see the [Slack documentation](https://api.slack.com/messaging/webhooks#enable_webhooks).

For more details, refer to [Slack Alert Method | Nobl9 Documentation](https://docs.nobl9.com/Alerting/Alert_methods/slack).
For more details, refer to [Slack Alert Method | Nobl9 Documentation](https://docs.nobl9.com/alerting/alert-methods/slack).

## Example Usage

Expand Down Expand Up @@ -47,4 +47,4 @@ resource "nobl9_alert_method_slack" "this" {

## Useful links

[Slack alerts configuration | Nobl9 Documentation](https://docs.nobl9.com/Alerting/slack/)
[Slack alerts configuration | Nobl9 Documentation](https://docs.nobl9.com/alerting/slack/)
8 changes: 4 additions & 4 deletions docs/resources/alert_method_webhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
page_title: "nobl9_alert_method_webhook Resource - terraform-provider-nobl9"
subcategory: "Alert Methods"
description: |-
Webhook Alert Method | Nobl9 Documentation https://docs.nobl9.com/Alerting/Alert_methods/webhook
Webhook Alert Method | Nobl9 Documentation https://docs.nobl9.com/alerting/alert-methods/webhook
---

# nobl9_alert_method_webhook (Resource)

The **Webhook Alert Method** enables sending alerts through an HTTP callback handler that is triggered by an event. You can create webhooks and configure them to handle different incident notifications, using either custom or predefined notification templates.

-> **NOTE** For details on how to use Webhook message templates, check the [Nobl9 documentation](https://docs.nobl9.com/Alerting/webhook#creating-webhook-custom-templates-through-yaml).
-> **NOTE** For details on how to use Webhook message templates, check the [Nobl9 documentation](https://docs.nobl9.com/alerting/webhook#creating-webhook-custom-templates-through-yaml).

For more details, refer to [Webhook Alert Method | Nobl9 Documentation](https://docs.nobl9.com/Alerting/Alert_methods/webhook).
For more details, refer to [Webhook Alert Method | Nobl9 Documentation](https://docs.nobl9.com/alerting/alert-methods/webhook).

## Example Usage

Expand Down Expand Up @@ -67,4 +67,4 @@ resource "nobl9_alert_method_webhook" "this" {

## Useful Links

[Webhook alerts documentation | Nobl9 Documentation](https://docs.nobl9.com/Alerting/webhook/)
[Webhook alerts documentation | Nobl9 Documentation](https://docs.nobl9.com/alerting/webhook/)
Loading

0 comments on commit e055d5a

Please sign in to comment.