fix: docs

keephq · Nov 5, 2024 · b3acb08 · b3acb08
1 parent a0052f3
commit b3acb08
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 12 deletions.
diff --git a/docs/images/pulling-enabled.png b/docs/images/pulling-enabled.png
diff --git a/docs/images/push-enabled.png b/docs/images/push-enabled.png
diff --git a/docs/overview/introduction.mdx b/docs/overview/introduction.mdx
@@ -1,26 +1,63 @@
 ---
 title: "Introduction"
-description: "Keep is an open-source alert management and automation tool that provides everything you need to collect, enrich and manage alerts effectively."
+description: "Keep is an open-source alert management and AIOps platform that is a swiss-knife for alerting, automation, and noise reduction."
 ---
-<Note> You can start using Keep by logging in to the [platform](https://platform.keephq.dev).</Note>
+
+<Note>
+  {" "}
+  You can start exploring Keep by simply logging in to the [platform](https://platform.keephq.dev).
+  Make sure to also join our [Slack community](https://slack.keephq.dev) to get help
+  and share your feedback.
+</Note>
 
 ## What's an alert?
 
 An alert is an event that is triggered when something undesirable occurs or is about to occur.
-It is usually triggered by monitoring tools such as Prometheus, Grafana, or CloudWatch, and some proprietary tools.
+It is usually triggered by monitoring tools. Example could include: Prometheus, Grafana, Datadog or CloudWatch, and your own proprietary tools.
 
 Alerts are usually categorized into three different groups:
+
 - Infrastructure-related alerts - e.g., a virtual machine consumes more than 99% CPU.
 - Application-related alerts - e.g., an endpoint starts returning 5XX status codes.
 - Business-related alerts - e.g., a drop in the number of sign-ins or purchases.
 
 ## What problem does Keep solve?
+
 Keep helps with every step of the alert lifecycle:
-1. Maintenance - Keep integrates with all of your monitoring tools, allowing you to manage all of your alerts within a single interface.
-2. Noise reduction - By integrating with monitoring tools, Keep can deduplicate and correlate alerts to reduce noise in your organization. There are 2 types of deduplication: Rule-based (all distributions), and AI-based (Keep Enterprise only).
-3. Automation - [Keep Workflows](/workflows) enables automated alert enrichment and response.
-4. Incident Correlation - Automatically assigns alerts to incidents, performs triage, and conducts root cause analysis (Keep Enterprise only).
-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](/providers/overview).
+
+1. Maintenance - Keep integrates with all of your monitoring tools, allowing you to manage all of your alerts within a single pane of glass.
+2. Noise reduction - By integrating with monitoring tools, Keep can deduplicate and correlate alerts to reduce noise in your organization. There are 2 types of deduplication: Rule-based (semi-manual) and AI-based (fully automated).
+3. Automation - [Keep Workflows](/workflows) is a GitHub Actions-like experience for automating anything that is triggered by things in Keep: alerts, events, incidents, manually and based on time intervals. It can help with: alert enrichment, ticket creation, self-healing, root cause analysis, and more.
+4. Incident Correlation - Correlate alerts to incidents, performs triage, and conducts root cause analysis.
+
+## How does Keep get my alerts?
+
+There are primarily two ways to get alerts into Keep:
+
+### Push
+
+When you connect a [Provider](/providers), Keep automatically instruments the tools to send alerts to Keep via webhook.
+As an example, when you connect Grafana, Keep will automatically create a new Webhook contact point in Grafana, and a new Notification Policy to send all alerts to Keep.
+
+You can configure which providers you want to push from by checking the `Install Webhook` checkbox in the provider settings.
+
+<Frame>
+  <img src="/images/pushing-enabled.png" />
+</Frame>
+
+### Pull
+
+When you connect a [Provider](/providers), Keep will start pulling alerts from the tool automatically.
+Pulling interval is defined by the `KEEP_PULL_INTERVAL` environment variable and defaults to 7 days and can be completely turned off by using the `KEEP_PULL_DATA_ENABLED` environment variable.
+
+You can also configure which providers you want to pull from by checking the `Pulling Enabled` checkbox in the provider settings.
+
+<Frame>
+  <img src="/images/pulling-enabled.png" />
+</Frame>
+
+<Tip>
+  We strongly recommend using the push method for alerting, as pulling does not
+  include a lot of the features, like workflow automation. It is mainly used for
+  a quick way to get alerts into Keep and start exploring the value.
+</Tip>
diff --git a/docs/providers/overview.mdx b/docs/providers/overview.mdx
@@ -24,7 +24,7 @@ By leveraging Keep Providers, users are able to deeply integrate Keep with the t
   title="Service Now"
   href="/providers/documentation/service-now-provider"
   icon={
-    <img src="https://img.logo.dev/service-now.com?token=pk_dfXfZBoKQMGDTIgqu7LvYg" />
+    <img src="https://img.logo.dev/servicenow.com?token=pk_dfXfZBoKQMGDTIgqu7LvYg" />
   }
 />