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.

Sign up for GitHub

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

fix: docs tests in main #2614

Merged
merged 4 commits into from
Nov 24, 2024
Merged

fix: docs tests in main #2614

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c2af8b2
Fix: docs tests in main
Matvey-Kuk Nov 24, 2024
29aed4a
Fix docs
Matvey-Kuk Nov 24, 2024
c0c95f8
Merge branch 'main' into Matvey-Kuk/fix-docs-tests
Matvey-Kuk Nov 24, 2024
131204b
Merge branch 'main' into Matvey-Kuk/fix-docs-tests
Matvey-Kuk Nov 24, 2024
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
4 changes: 2 additions & 2 deletions .github/workflows/test-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@ name: Test docs
on:
push:
paths:
- 'keep/poviders/**'
- 'keep/providers/**'
- 'docs/**'
pull_request:
paths:
- 'keep/poviders/**'
- 'keep/providers/**'
- 'docs/**'
workflow_dispatch:
concurrency:
Expand Down
6 changes: 3 additions & 3 deletions docs/providers/documentation/gke-provider.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "GKE"
sidebarTitle: "GKE Provider"
description: "GKE provider allows managing Google Kubernetes Engine clusters and related resources."
title: "Google Kubernetes Engine"
sidebarTitle: "Google Kubernetes Engine Provider"
description: "Google Kubernetes Engine provider allows managing Google Kubernetes Engine clusters and related resources."
---

## Inputs
Expand Down
6 changes: 3 additions & 3 deletions docs/providers/documentation/teams-provider.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Teams Provider"
sidebarTitle: "Teams Provider"
description: "Teams Provider is a provider that allows to notify alerts to Microsoft Teams chats."
title: "Microsoft Teams Provider"
sidebarTitle: "Microsoft Teams Provider"
description: "Microsoft Teams Provider is a provider that allows to notify alerts to Microsoft Teams chats."
---

## Inputs
Expand Down
4 changes: 2 additions & 2 deletions docs/providers/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ By leveraging Keep Providers, users are able to deeply integrate Keep with the t
/>

<Card
title="GKE"
title="Google Kubernetes Engine"
href="/providers/documentation/gke-provider"
icon={
<img src="https://img.logo.dev/gke.com?token=pk_dfXfZBoKQMGDTIgqu7LvYg" />
Expand Down Expand Up @@ -653,7 +653,7 @@ By leveraging Keep Providers, users are able to deeply integrate Keep with the t
></Card>

<Card
title="Teams"
title="Microsoft Teams"
href="/providers/documentation/teams-provider"
icon={
<img src="https://img.logo.dev/teams.com?token=pk_dfXfZBoKQMGDTIgqu7LvYg" />
Expand Down
6 changes: 3 additions & 3 deletions scripts/docs_get_providers_list.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,8 @@

LOGO_DEV_PUBLISHABLE_KEY = "pk_dfXfZBoKQMGDTIgqu7LvYg"

NON_DOCUMENTED_PROVIDERS = (
[]
) # known not documented providers https://github.com/keephq/keep/issues/2033
NON_DOCUMENTED_PROVIDERS = [
]


def validate_overview_is_complete(documented_providers):
Expand Down Expand Up @@ -49,6 +48,7 @@ def validate_all_providers_are_documented(documented_providers):
if (
provider_name not in documented_providers
and provider_name not in NON_DOCUMENTED_PROVIDERS
and not provider.coming_soon
):
raise Exception(
f"""Provider "{provider_name}" is not documented in the docs/providers/documentation folder,
Expand Down
Loading