Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Fix typos on multiple pages of Keep Docs Site #2288

Merged
merged 1 commit into from
Oct 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/deployment/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Resource provisioning settings control how Keep sets up initial resources. This
<Info>
Authentication configuration determines how Keep verifies user identities and manages access control. These settings are essential for securing your Keep instance and integrating with various authentication providers.
</Info>
<Tip>For specifc authentication type configuration, please see [authentication docs](/deployment/authentication/overview).</Tip>
<Tip>For specific authentication type configuration, please see [authentication docs](/deployment/authentication/overview).</Tip>


| Env var | Purpose | Required | Default Value | Valid options |
Expand Down
2 changes: 1 addition & 1 deletion docs/deployment/ecs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ sidebarTitle: "AWS ECS"
- Configuration Type: Configure at task definition creation
- Volume type: EFS
- Storage configurations:
- File system ID: Select an exisiting EFS filesystem or create a new one
- File system ID: Select an existing EFS filesystem or create a new one
- Root Directory: /
![Volume Configuration](/images/ecs-task-def-backend5.png)
- Container mount points:
Expand Down
2 changes: 1 addition & 1 deletion docs/deployment/stress-testing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The primary parameters that affect the specification requirements for Keep are:
3. **Number of Workflows**: How many automation run as a result of alert.

### Main Components:
- **Keep Backend** - API and buisness logic. A container that serves FastAPI on top of gunicorn.
- **Keep Backend** - API and business logic. A container that serves FastAPI on top of gunicorn.
- **Keep Frontend** - Web app. A container that serves the react app.
- **Database** - Stores the alerts and any other operational data.
- **Elasticsearch** (opt out by default) - Stores alerts as document for better search performance.
Expand Down
2 changes: 1 addition & 1 deletion docs/overview/comparisons.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Keep is different because it’s able to correlate alerts between different obse
| | Keep | Alternative |
| ------------------------------------- | -------------------------------------------------------------- | ---------------------------- |
| Aggregates alerts from one platform | βœ… | βœ… |
| Aggregates alerts from mutliple platforms | βœ… | ❌ |
| Aggregates alerts from multiple platforms | βœ… | ❌ |
| Correlates alerts between multiple sources | βœ… | ❌ |
| Alerts enrichment | βœ… | ❌ |
| Open source | βœ… | ❌ |
Expand Down
2 changes: 1 addition & 1 deletion docs/overview/deduplication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Alert deduplication is a crucial feature in Keep that helps reduce noise and str
Partial deduplication allows you to specify certain fields (fingerprint fields) that are used to identify similar alerts. Alerts with matching values in these specified fields are considered duplicates and are grouped together. This method is flexible and allows for fine-tuned control over how alerts are deduplicated.

Every provider integrated with Keep comes with pre-built partial deduplication rule tailored to that provider's specific alert format and common use cases.
The default fingerprint fields defined using `FINGERPRINT_FIELDS` attributes in the provider code (e.g. [datadog provider](https://github.com/keephq/keep/blob/main/keep/providers/datadog_provider/datadog_provider.py#L188) or [gcp monitoring provder](https://github.com/keephq/keep/blob/main/keep/providers/gcpmonitoring_provider/gcpmonitoring_provider.py#L52)).
The default fingerprint fields defined using `FINGERPRINT_FIELDS` attributes in the provider code (e.g. [datadog provider](https://github.com/keephq/keep/blob/main/keep/providers/datadog_provider/datadog_provider.py#L188) or [gcp monitoring provider](https://github.com/keephq/keep/blob/main/keep/providers/gcpmonitoring_provider/gcpmonitoring_provider.py#L52)).

### Full Deduplication
When full deduplication is enabled, Keep will also discard exact same events (excluding ignore fields). This mode considers all fields of an alert when determining duplicates, except for explicitly ignored fields.
Expand Down
Loading