diff --git a/docs/mint.json b/docs/mint.json index 191697a2b..200a242a7 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -86,12 +86,9 @@ "group": "Platform", "pages": [ "platform/overview", - "platform/providers", "platform/alerts", "platform/alertseverityandstatus", - "platform/workflows", "platform/settings", - "platform/metrics", "platform/support" ] }, @@ -188,7 +185,6 @@ "group": "Workflows", "pages": [ "workflows/overview", - "workflows/getting-started", { "group": "Syntax", "pages": [ diff --git a/docs/overview/examples.mdx b/docs/overview/examples.mdx index e5e564141..69ae876c1 100644 --- a/docs/overview/examples.mdx +++ b/docs/overview/examples.mdx @@ -14,7 +14,7 @@ In this example we will utilze: This example consists of two steps: 1. Connect your tools - Datadog, OpsGenie and Postgres. -2. Create a workflow that is triggered by the alert, runs an SQL query, and decides whether to create an incident. Once the workflow is created, you can upload it via the [Workflows](/platform/workflows) page. +2. Create a workflow that is triggered by the alert, runs an SQL query, and decides whether to create an incident. Once the workflow is created, you can upload it via the [Workflows](https://docs.keephq.dev/workflows/overview) page. ```yaml alert: id: enterprise-tier-alerts diff --git a/docs/overview/introduction.mdx b/docs/overview/introduction.mdx index 557889296..b52681e87 100644 --- a/docs/overview/introduction.mdx +++ b/docs/overview/introduction.mdx @@ -23,4 +23,4 @@ Keep helps with every step of the alert lifecycle: 5. Summarization - Keep summarizes incidents based on past incidents and a knowledge base (Keep Enterprise only). ## How does Keep integrate with alerts? -Alerts can either be [pulled](/platform/alerts#pulled-alerts) by Keep or [pushed](/platform/alerts#pushed-alerts) into it. Keep also offers zero-click alert instrumentation through [webhook installation](/platform/providers#webhook-integration). \ No newline at end of file +Alerts can either be [pulled](/platform/alerts#pulled-alerts) by Keep or [pushed](/platform/alerts#pushed-alerts) into it. Keep also offers zero-click alert instrumentation through [webhook installation](/providers/overview). \ No newline at end of file diff --git a/docs/overview/keyconcepts.mdx b/docs/overview/keyconcepts.mdx index 3e76a2dca..07c2193fe 100644 --- a/docs/overview/keyconcepts.mdx +++ b/docs/overview/keyconcepts.mdx @@ -27,7 +27,7 @@ For example, consider Promethues. If you want to push alerts from Promethues to 'https://api.keephq.dev/alerts/event/prometheus' using API key authentication. Each Provider implements Push mechanism and is documented under the specific Provider page. #### Push alerts to Keep (Automatic) -In compatible tools, Keep can automatically integrate with the alerting policy of the source tool and add itself as an alert destination. You can learn more about Webhook Integration [here](/platform/providers#webhook-integration). +In compatible tools, Keep can automatically integrate with the alerting policy of the source tool and add itself as an alert destination. You can learn more about Webhook Integration [here](/providers/overview). Please note that this will slightly modify your monitors/notification policy. ### Pull alerts by Keep diff --git a/docs/platform/overview.mdx b/docs/platform/overview.mdx index 93051bfc9..bb3f3b809 100644 --- a/docs/platform/overview.mdx +++ b/docs/platform/overview.mdx @@ -9,7 +9,7 @@ The platform is accessible on https://platform.keephq.dev and let you start the The platform is currently built on top of: -1. [Providers](/platform/providers) - connect your stack to Keep. +1. [Providers](/providers/overview) - connect your stack to Keep. 2. [Alerts](/platform/alerts) - single pane of glass for your alerts. -3. [Workflows](/platform/workflows) - create automations on top of your alerts (or regardless). +3. [Workflows](/workflows/overview) - create automations on top of your alerts (or regardless). 4. [Settings](/platform/settings) - the settings page (add users, etc). diff --git a/docs/platform/providers.mdx b/docs/platform/providers.mdx deleted file mode 100644 index f9e28cfd1..000000000 --- a/docs/platform/providers.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: "Providers" -sidebarTitle: Providers ---- - -## Overview -You can manage Providers programmatically using the Providers API. -The providers page let you manage your Providers in easy way. - - - - - -## Connecting your first Provider -To connect a Provider, just click on the Provider tile. - - - -You'll need to provide: -1. Provider name. -2. Provider authentication details. -Each provider has its own authentication process. To learn about a specific Provider authentication, you can go to the Provider page. - - -## Webhook Integration -The webhook integration let you seamlessly push your alerts to Keep. -It means that when you connect the Provider, Keep hooks the Provider configuration to add itself as a destination. -After install - -A webhook integration available if it has "Webhook available" icon: - - - - -## Delete a Provider -To delete a Provider, just click on the right bottom corner of the Provider tile: - - - - diff --git a/docs/platform/workflows.mdx b/docs/platform/workflows.mdx deleted file mode 100644 index d7e8b7ac7..000000000 --- a/docs/platform/workflows.mdx +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: "Workflows" -sidebarTitle: Workflows ---- - -## Overview -You can manage Workflows programmatically using the Workflow API. -The Workflows page implements a convinent interface to manage your workflows. - -Workflows can be triggered by: - -1. Alert -2. Predefined interval -3. Manually - -You can learn more about how to [create workflows](/workflows/getting-started) and about the [workflows syntax](/workflows/syntax) in the workflows docs or in the [examples](https://github.com/keephq/keep/tree/main/examples/workflows) section in Keep repository. - -## Upload a Workflow -Drop your workflow yaml file or use the "upload workflow": - - - - -## Connect a missing Provider -When you upload a Workflow, Keep parse it and checks what Providers this workflow needs in order to run. -If the provider is not installed, the Workflow won't be able to run. To install the missing Provider, just click on the "install" link: - - - - - -You will be taken to the specific Provider installation page: - - - - -## Run a Workflow manually -If a Workflow was defined with the manual trigger, the "run manually" button will be enabled: - - - - - - -## Delete a Workflow -To delete a Workflow, just click on the "trash icon": - - - - - -## View Workflow executions history - - - - -## View a specific Workflow execution logs - - - diff --git a/docs/workflows/getting-started.mdx b/docs/workflows/getting-started.mdx deleted file mode 100644 index a29f002f2..000000000 --- a/docs/workflows/getting-started.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "Getting started" -sidebarTitle: "Getting started" ---- - -# Docker-compose -The easiest way to start keep is by running it on docker-compose: -docker-compose up -`` - -# Kubernetes -Keep can be installed via Helm Chart using the following command: -``` -helm repo add keephq https://keephq.github.io/helm-charts -helm pull keephq/keep -helm install keep keephq/keep -``` - -Notice for it to work locally, you'll need this port forwarding: -`kubectl port-forward svc/keep-frontend 3000:3000` -`kubectl port-forward svc/keep-backend 8080:8080` - -For specifics, see https://github.com/keephq/keep/blob/main/chart/keep/README.md - -# Development -You could use `docker-compose.dev.yaml` to start Keep in a development mode (see Dockerfile.dev.ui / Dockerfile.dev.api)