From 32d68fabd5dccb5e88480db64cdbd0e7af56f7db Mon Sep 17 00:00:00 2001 From: Matvey Kukuy Date: Sun, 29 Sep 2024 16:55:59 +0300 Subject: [PATCH] Test if all providers are documented --- .../azuremonitoring-provider.mdx | 12 +- .../documentation/grafana_oncall-provider.mdx | 20 +- .../documentation/jira-on-prem-provider.mdx | 7 + .../providers/documentation/jira-provider.mdx | 6 +- docs/providers/overview.mdx | 296 +++++------------- keep/providers/aks_provider/aks_provider.py | 2 +- .../grafana_oncall_provider.py | 10 +- .../jiraonprem_provider.py | 2 +- scripts/docs_get_providers_list.py | 45 ++- 9 files changed, 149 insertions(+), 251 deletions(-) create mode 100644 docs/providers/documentation/jira-on-prem-provider.mdx diff --git a/docs/providers/documentation/azuremonitoring-provider.mdx b/docs/providers/documentation/azuremonitoring-provider.mdx index f47a54be8..65e22a1cd 100644 --- a/docs/providers/documentation/azuremonitoring-provider.mdx +++ b/docs/providers/documentation/azuremonitoring-provider.mdx @@ -1,16 +1,16 @@ --- -title: "Azure Monitoring" -sidebarTitle: "Azure Monitoring Provider" -description: "Azure Monitoring provider allows you to get alerts from Azure Monitoring via webhooks." +title: "Azure Monitor" +sidebarTitle: "Azure Monitor Provider" +description: "Azure Monitorg provider allows you to get alerts from Azure Monitor via webhooks." --- ## Overview -The Azure Monitoring Provider integrates Keep with Azure Monitoring, allowing you to receive alerts within Keep's platform. By setting up a webhook in Azure, you can ensure that critical alerts are sent to Keep, allowing for efficient monitoring and response. +The Azure Monitor Provider integrates Keep with Azure Monitor, allowing you to receive alerts within Keep's platform. By setting up a webhook in Azure, you can ensure that critical alerts are sent to Keep, allowing for efficient monitoring and response. -## Connecting Azure Monitoring to Keep +## Connecting Azure Monitor to Keep -Connecting Azure Monitoring to Keep involves creating an Action Group in Azure, adding a webhook action, and configuring the Alert Rule to use the new Action Group. +Connecting Azure Monitor to Keep involves creating an Action Group in Azure, adding a webhook action, and configuring the Alert Rule to use the new Action Group. ### Step 1: Navigate an Action Group 1. Log in to your Azure portal. diff --git a/docs/providers/documentation/grafana_oncall-provider.mdx b/docs/providers/documentation/grafana_oncall-provider.mdx index 0124acae2..4e8160873 100644 --- a/docs/providers/documentation/grafana_oncall-provider.mdx +++ b/docs/providers/documentation/grafana_oncall-provider.mdx @@ -1,6 +1,6 @@ --- -title: "Grafana Oncall Provider" -description: "Grafana Oncall Provider is a class that allows to ingest/digest data from Grafana On-Call." +title: "Grafana OnCall Provider" +description: "Grafana Oncall Provider is a class that allows to ingest/digest data from Grafana OnCall." --- ## Inputs @@ -21,16 +21,16 @@ Grafana Oncall Provider does not currently support the `query` function. ## Authentication Parameters -The Grafana Oncall Provider uses API token authentication. You need to provide the following authentication parameters to connect to Grafana On-Call: +The Grafana Oncall Provider uses API token authentication. You need to provide the following authentication parameters to connect to Grafana OnCall: -- **token** (required): Your Grafana On-Call API Token. -- **host** (required): The URL of your Grafana On-Call host (e.g., https://keephq.grafana.net). +- **token** (required): Your Grafana OnCall API Token. +- **host** (required): The URL of your Grafana OnCall host (e.g., https://keephq.grafana.net). ## Connecting with the Provider -To connect to Grafana On-Call, you need to create an API Token: +To connect to Grafana OnCall, you need to create an API Token: -1. Log in to your Grafana On-Call account. +1. Log in to your Grafana OnCall account. 2. Go to the **API Tokens** page. 3. Click the **Generate Token** button and provide a name for your token. 4. Copy the token value and keep it secure. @@ -38,7 +38,7 @@ To connect to Grafana On-Call, you need to create an API Token: ## Notes -- This provider allows you to interact with Grafana On-Call to create or update incidents. +- This provider allows you to interact with Grafana OnCall to create or update incidents. - The `random_color` function generates a random color for incident labels. - The `startTime` and `endTime` parameters use ISO-8601 format. - The `notify` function returns information about the incident created or updated. @@ -97,5 +97,5 @@ Payload example: ## Useful Links -- [Grafana On-Call](https://keephq.grafana.net) -- [Grafana On-Call API Documentation](https://keephq.grafana.net/docs/api) +- [Grafana OnCall](https://keephq.grafana.net) +- [Grafana OnCall API Documentation](https://keephq.grafana.net/docs/api) diff --git a/docs/providers/documentation/jira-on-prem-provider.mdx b/docs/providers/documentation/jira-on-prem-provider.mdx new file mode 100644 index 000000000..297587f36 --- /dev/null +++ b/docs/providers/documentation/jira-on-prem-provider.mdx @@ -0,0 +1,7 @@ +--- +title: "Jira On-Prem Provider" +sidebarTitle: "Jira On-Prem Provider" +description: "Jira On-Prem Provider is a provider used to query data and creating issues in Jira" +--- + +Keep supports Jira OnPrem as a provider. Please check [Jira Provider](jira-provider.md) for documentation. \ No newline at end of file diff --git a/docs/providers/documentation/jira-provider.mdx b/docs/providers/documentation/jira-provider.mdx index 0ab6badcd..b00d669a0 100644 --- a/docs/providers/documentation/jira-provider.mdx +++ b/docs/providers/documentation/jira-provider.mdx @@ -1,7 +1,7 @@ --- -title: "Jira Provider" -sidebarTitle: "Jira Provider" -description: "Jira provider is a provider used to query data and creating issues in Jira" +title: "Jira Cloud Provider" +sidebarTitle: "Jira Cloud Provider" +description: "Jira Cloud provider is a provider used to query data and creating issues in Jira" --- ## Inputs diff --git a/docs/providers/overview.mdx b/docs/providers/overview.mdx index 49069603c..818890cea 100644 --- a/docs/providers/overview.mdx +++ b/docs/providers/overview.mdx @@ -15,569 +15,433 @@ By leveraging Keep Providers, users are able to deeply integrate Keep with the t - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > } +> + + - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > - } + icon={ } > grafana @@ -100,7 +126,7 @@ def main(): > """ mintlify_cards += new_card - providers_to_validate.append(provider_name) + documented_providers.append(provider_name) mintlify_cards += "" # Checking --validate flag @@ -110,7 +136,8 @@ def main(): # If --validate flag is set, print the list of providers to validate if args.validate: - validate(providers_to_validate=providers_to_validate) + validate_all_providers_are_documented(documented_providers) + validate_overview_is_complete(documented_providers) else: print(mintlify_cards)