From 77c864aa989c7c4d5e867b7b74d717c8b6501dc1 Mon Sep 17 00:00:00 2001 From: Angel Date: Mon, 21 Oct 2024 16:06:38 -0400 Subject: [PATCH 1/6] save --- app/konnect/service-catalog/index.md | 3 +++ app/konnect/service-catalog/integrations/github.md | 11 +++++++++++ 2 files changed, 14 insertions(+) diff --git a/app/konnect/service-catalog/index.md b/app/konnect/service-catalog/index.md index aa0fb7d9172..12937941902 100644 --- a/app/konnect/service-catalog/index.md +++ b/app/konnect/service-catalog/index.md @@ -61,6 +61,7 @@ graph LR | Keep track of your organization's resource ownership by mapping teams to Service Catalog services. | Add the Service Catalog service's owner when you [create a new Service Catalog service in {{site.konnect_short_name}}](https://cloud.konghq.com/service-catalog/create-service) | | Gain visibility into all your services, including unrecognized or undiscovered APIs in your organization. | [Service Catalog integrations](https://cloud.konghq.com/service-catalog/integrations) | | Consolidate key Service Catalog service health metrics, documentation, and API specs into a single list, allowing you to interact with other tools from one place. | [Service Catalog dashboard](https://cloud.konghq.com/service-catalog/) | +| View integration-related events (like pull requests, merges, or configuration changes) associated with your Service Catalog services. | Use the **Events** tab. | @@ -73,6 +74,8 @@ graph LR | Resource | An umbrella term that denotes entities ingested by Service Catalog from enabled integrations. A resource can range from an infrastructural component (like Gateway services, mesh services, databases, and caches) to an external application or tool (like code repositories, CI/CD infrastructure, and on-call systems) to a piece of documentation (like API specs). Resources can be mapped to one or more Service Catalog services. | | Service Catalog service | A unit of software that is typically owned by a single team, exposes one or more APIs, and may be dependent on other Service Catalog services (as either upstream or downstream). A Service Catalog service can be thought of as a collection of one or more resources. | | Service Catalog | A comprehensive catalog of all resources and Service Catalog services running in your organization. | +| Events | An event is a captured unit of information logged by the Service Catalog. It includes a wide range of activities such as user-driven actions, configuration changes, and alerts. | + ## FAQs diff --git a/app/konnect/service-catalog/integrations/github.md b/app/konnect/service-catalog/integrations/github.md index 0dc867224bd..c3bc0f6681a 100644 --- a/app/konnect/service-catalog/integrations/github.md +++ b/app/konnect/service-catalog/integrations/github.md @@ -32,6 +32,17 @@ Entity | Description -------|------------- Repository | A GitHub repository relating to the service +## Supported events + +Supported events include the following actions: + +| Event Type | +|----------------------------| +| Pull request opened | +| Pull request merged | +| Pull request closed | + + ## Discovery information From 186a2938ade63006caa237b566050ab1d3003cbb Mon Sep 17 00:00:00 2001 From: Angel Date: Tue, 22 Oct 2024 15:46:32 -0400 Subject: [PATCH 2/6] eventing docs plus small fixes --- app/_assets/stylesheets/badges.less | 7 +++++++ app/_data/tables/konnect/integrations.yml | 2 ++ .../service-catalog-integrations.html | 3 +++ app/konnect/service-catalog/index.md | 20 +++++++++---------- .../service-catalog/integrations/github.md | 12 +++++------ .../service-catalog/integrations/index.md | 7 ++++++- 6 files changed, 33 insertions(+), 18 deletions(-) diff --git a/app/_assets/stylesheets/badges.less b/app/_assets/stylesheets/badges.less index 02705b50608..0236a41f3c2 100644 --- a/app/_assets/stylesheets/badges.less +++ b/app/_assets/stylesheets/badges.less @@ -28,6 +28,13 @@ text-fill-color: transparent; } } + &.events::after { + content: "Supports Events"; + color: white; + background: linear-gradient(90deg, #5052FD 0%, #033796 100%); + padding: 5px 12px 4px; + text-align: center; + } &.techpartner::after { content: "TECH PARTNER"; diff --git a/app/_data/tables/konnect/integrations.yml b/app/_data/tables/konnect/integrations.yml index 961badc6ec8..1fba946caf6 100644 --- a/app/_data/tables/konnect/integrations.yml +++ b/app/_data/tables/konnect/integrations.yml @@ -6,6 +6,7 @@ integrations: - name: GitHub icon: github.svg slug: github + events: true description: Associate a service to one or more GitHub repositories - name: Traceable.io icon: traceable.svg @@ -22,4 +23,5 @@ integrations: # Put icon in /assets/images/icons/third-party/. # slug: The filename of the integration page itself, used for links. Don't include the file extension (e.g. .md) # E.g. if the page is at /konnect/service-catalog/integrations/pagerduty, the slug is pagerduty + # events: True if the integration supports eventing. # description: Short description (100 char max) of the integration diff --git a/app/_includes/service-catalog-integrations.html b/app/_includes/service-catalog-integrations.html index 7897f8d386b..5c00fa62e8a 100644 --- a/app/_includes/service-catalog-integrations.html +++ b/app/_includes/service-catalog-integrations.html @@ -7,6 +7,9 @@ {{ i.name }}
{{i.description}}
+ {% if i.events == true %} + + {% endif %} {% endfor %} diff --git a/app/konnect/service-catalog/index.md b/app/konnect/service-catalog/index.md index 12937941902..d94f44925fd 100644 --- a/app/konnect/service-catalog/index.md +++ b/app/konnect/service-catalog/index.md @@ -54,27 +54,26 @@ graph LR > *Figure 1: This diagram shows how you can use both external integrations, like GitHub and PagerDuty, as well as internal integrations like Gateway Manager to pull resources into Service Catalog. You can then map those resources (like GitHub repositories, PagerDuty services, and Gateway services) to Service Catalog services.* -## Service Catalog use cases +## {{site.service_catalog_name}} use cases | You want to... | Then use... | | -------------- | ----------- | -| Keep track of your organization's resource ownership by mapping teams to Service Catalog services. | Add the Service Catalog service's owner when you [create a new Service Catalog service in {{site.konnect_short_name}}](https://cloud.konghq.com/service-catalog/create-service) | -| Gain visibility into all your services, including unrecognized or undiscovered APIs in your organization. | [Service Catalog integrations](https://cloud.konghq.com/service-catalog/integrations) | -| Consolidate key Service Catalog service health metrics, documentation, and API specs into a single list, allowing you to interact with other tools from one place. | [Service Catalog dashboard](https://cloud.konghq.com/service-catalog/) | -| View integration-related events (like pull requests, merges, or configuration changes) associated with your Service Catalog services. | Use the **Events** tab. | +| Keep track of your organization's resource ownership by mapping teams to {{site.service_catalog_name}} services. | Add the {{site.service_catalog_name}}service's owner when you [create a new {{site.service_catalog_name}} service in {{site.konnect_short_name}}](https://cloud.konghq.com/service-catalog/create-service) | +| Gain visibility into all your services, including unrecognized or undiscovered APIs in your organization. | [{{site.service_catalog_name}} integrations](https://cloud.konghq.com/service-catalog/integrations) | +| Consolidate key {{site.service_catalog_name}} service health metrics, documentation, and API specs into a single list, allowing you to interact with other tools from one place. | [{{site.service_catalog_name}} dashboard](https://cloud.konghq.com/service-catalog/) | -## Service Catalog terminology +## {{site.service_catalog_name}} terminology | Term | Definition | | ---- | ---------- | | Integration | These are applications, either {{site.konnect_short_name}}-internal or external, that act as sources from which you can ingest resources. For example, GitHub. | -| Resource | An umbrella term that denotes entities ingested by Service Catalog from enabled integrations. A resource can range from an infrastructural component (like Gateway services, mesh services, databases, and caches) to an external application or tool (like code repositories, CI/CD infrastructure, and on-call systems) to a piece of documentation (like API specs). Resources can be mapped to one or more Service Catalog services. | -| Service Catalog service | A unit of software that is typically owned by a single team, exposes one or more APIs, and may be dependent on other Service Catalog services (as either upstream or downstream). A Service Catalog service can be thought of as a collection of one or more resources. | -| Service Catalog | A comprehensive catalog of all resources and Service Catalog services running in your organization. | -| Events | An event is a captured unit of information logged by the Service Catalog. It includes a wide range of activities such as user-driven actions, configuration changes, and alerts. | +| Resource | An umbrella term that denotes entities ingested by {{site.service_catalog_name}} from enabled integrations. A resource can range from an infrastructural component (like Gateway services, mesh services, databases, and caches) to an external application or tool (like code repositories, CI/CD infrastructure, and on-call systems) to a piece of documentation (like API specs). Resources can be mapped to one or more {{site.service_catalog_name}} services. | +| {{site.service_catalog_name}} service | A unit of software that is typically owned by a single team, exposes one or more APIs, and may be dependent on other {{site.service_catalog_name}} services (as either upstream or downstream). A {{site.service_catalog_name}} service can be thought of as a collection of one or more resources. | +| {{site.service_catalog_name}} | A comprehensive catalog of all resources and {{site.service_catalog_name}} services running in your organization. | +| Events | An [event](/konnect/service-catalog/integrations/#events) is a captured unit of information logged by the {{site.service_catalog_name}}. It includes a wide range of activities such as user-driven actions, configuration changes, and alerts. | ## FAQs @@ -131,4 +130,3 @@ Yes, you can configure access controls and manage permissions to Service Catalog ## More information * [Service Catalog integrations](/konnect/service-catalog/integrations) - diff --git a/app/konnect/service-catalog/integrations/github.md b/app/konnect/service-catalog/integrations/github.md index c3bc0f6681a..64db7e48b29 100644 --- a/app/konnect/service-catalog/integrations/github.md +++ b/app/konnect/service-catalog/integrations/github.md @@ -11,7 +11,7 @@ mechanism: "pull/ingestion model" _Type: External_ -The GitHub integration allows you to associate your Service Catalog service to one or more GitHub repositories. +The GitHub integration allows you to associate your {{site.service_catalog_name}} service to one or more GitHub repositories. For each linked Repository, the UI can show a **Repository Summary** with simple data pulled from the GitHub API, such as the number of open issues, open pull requests, most recently closed pull requests, languages, and more. @@ -32,15 +32,15 @@ Entity | Description -------|------------- Repository | A GitHub repository relating to the service -## Supported events +## Events -Supported events include the following actions: +The Eventing feature supports viewing the following event types for linked repositories from the {{site.konnect_product_name}} UI. | Event Type | |----------------------------| -| Pull request opened | -| Pull request merged | -| Pull request closed | +| Open pull request | +| Merge pull request | +| Close pull request | ## Discovery information diff --git a/app/konnect/service-catalog/integrations/index.md b/app/konnect/service-catalog/integrations/index.md index 876695c40de..d75e202e498 100644 --- a/app/konnect/service-catalog/integrations/index.md +++ b/app/konnect/service-catalog/integrations/index.md @@ -6,13 +6,18 @@ beta: true --- Integrations are applications - either {{site.konnect_short_name}}-internal applications or external -third-party applications - that you can enable or disable within Service Catalog. +third-party applications - that you can enable or disable within {{site.service_catalog_name}}. When enabled, an integration gives you and your teams the ability to: * Discover new resources * Create new services based on existing resources +* View key events associated with the integration directly in the event tab in {{site.konnect_saas}}. ## Integrations {% include_cached service-catalog-integrations.html %} + +## Events + +Eventing allows you to view key events associated with your {{site.service_catalog_name}} integrations directly from the Events tab in the {{site.konnect_saas}} UI. From here you can search or filter through events by keywords in the event title and filter by time frame. \ No newline at end of file From 3c86641495c094e33551e609f35782ba59bedf7c Mon Sep 17 00:00:00 2001 From: Angel Date: Tue, 22 Oct 2024 15:51:26 -0400 Subject: [PATCH 3/6] Update app/konnect/service-catalog/integrations/index.md --- app/konnect/service-catalog/integrations/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/konnect/service-catalog/integrations/index.md b/app/konnect/service-catalog/integrations/index.md index d75e202e498..b80cbc4f8c3 100644 --- a/app/konnect/service-catalog/integrations/index.md +++ b/app/konnect/service-catalog/integrations/index.md @@ -20,4 +20,4 @@ When enabled, an integration gives you and your teams the ability to: ## Events -Eventing allows you to view key events associated with your {{site.service_catalog_name}} integrations directly from the Events tab in the {{site.konnect_saas}} UI. From here you can search or filter through events by keywords in the event title and filter by time frame. \ No newline at end of file +Eventing allows you to view key events associated with your {{site.service_catalog_name}} integrations directly from the **Events** tab in the {{site.konnect_saas}} UI. From here you can search or filter through events by keywords in the event title and filter by time frame. \ No newline at end of file From 197a8e7e24a1d123d5c2aaa52bfb848a1450ae14 Mon Sep 17 00:00:00 2001 From: Angel Date: Fri, 25 Oct 2024 14:57:40 -0400 Subject: [PATCH 4/6] fix table and variable --- app/konnect/service-catalog/integrations/github.md | 10 +++++----- app/konnect/service-catalog/integrations/index.md | 5 ++--- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/app/konnect/service-catalog/integrations/github.md b/app/konnect/service-catalog/integrations/github.md index 64db7e48b29..61d548f36c3 100644 --- a/app/konnect/service-catalog/integrations/github.md +++ b/app/konnect/service-catalog/integrations/github.md @@ -36,11 +36,11 @@ Repository | A GitHub repository relating to the service The Eventing feature supports viewing the following event types for linked repositories from the {{site.konnect_product_name}} UI. -| Event Type | -|----------------------------| -| Open pull request | -| Merge pull request | -| Close pull request | +Event types: + +* Open pull request +* Merge pull request +* Close pull request ## Discovery information diff --git a/app/konnect/service-catalog/integrations/index.md b/app/konnect/service-catalog/integrations/index.md index b80cbc4f8c3..6305d4c4953 100644 --- a/app/konnect/service-catalog/integrations/index.md +++ b/app/konnect/service-catalog/integrations/index.md @@ -6,12 +6,11 @@ beta: true --- Integrations are applications - either {{site.konnect_short_name}}-internal applications or external -third-party applications - that you can enable or disable within {{site.service_catalog_name}}. When enabled, an integration gives you and your teams the ability to: * Discover new resources * Create new services based on existing resources -* View key events associated with the integration directly in the event tab in {{site.konnect_saas}}. +* View key events associated with the integration directly in the event tab in {{site.konnect_short_name}}. ## Integrations @@ -20,4 +19,4 @@ When enabled, an integration gives you and your teams the ability to: ## Events -Eventing allows you to view key events associated with your {{site.service_catalog_name}} integrations directly from the **Events** tab in the {{site.konnect_saas}} UI. From here you can search or filter through events by keywords in the event title and filter by time frame. \ No newline at end of file +Eventing allows you to view key events associated with your {{site.service_catalog_name}} integrations directly from the **Events** tab in the {{site.konnect_short_name}} UI. From here you can search or filter through events by keywords in the event title and filter by time frame. From 1720ad3be16c6154f5b6d75fedd668a9b67b00f8 Mon Sep 17 00:00:00 2001 From: Angel Date: Thu, 31 Oct 2024 12:05:26 -0400 Subject: [PATCH 5/6] Apply suggestions from code review Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> --- app/_assets/stylesheets/badges.less | 4 ++-- app/_includes/service-catalog-integrations.html | 1 + app/konnect/service-catalog/integrations/index.md | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/app/_assets/stylesheets/badges.less b/app/_assets/stylesheets/badges.less index 0236a41f3c2..f4f5a59e1aa 100644 --- a/app/_assets/stylesheets/badges.less +++ b/app/_assets/stylesheets/badges.less @@ -30,8 +30,8 @@ } &.events::after { content: "Supports Events"; - color: white; - background: linear-gradient(90deg, #5052FD 0%, #033796 100%); + color: #3972d5; + background: #f2f6fe; padding: 5px 12px 4px; text-align: center; } diff --git a/app/_includes/service-catalog-integrations.html b/app/_includes/service-catalog-integrations.html index 5c00fa62e8a..3390ed2dc51 100644 --- a/app/_includes/service-catalog-integrations.html +++ b/app/_includes/service-catalog-integrations.html @@ -8,6 +8,7 @@
{{i.description}}
{% if i.events == true %} +
{% endif %} diff --git a/app/konnect/service-catalog/integrations/index.md b/app/konnect/service-catalog/integrations/index.md index 6305d4c4953..8bc8c592fac 100644 --- a/app/konnect/service-catalog/integrations/index.md +++ b/app/konnect/service-catalog/integrations/index.md @@ -10,7 +10,7 @@ Integrations are applications - either {{site.konnect_short_name}}-internal appl When enabled, an integration gives you and your teams the ability to: * Discover new resources * Create new services based on existing resources -* View key events associated with the integration directly in the event tab in {{site.konnect_short_name}}. +* View key events associated with the integration directly in the event tab in {{site.konnect_short_name}} ## Integrations From 619f8fa2070b474ae3b82217c7dbd603ed805e27 Mon Sep 17 00:00:00 2001 From: Angel Date: Thu, 31 Oct 2024 12:07:10 -0400 Subject: [PATCH 6/6] Apply suggestions from code review Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> --- app/konnect/service-catalog/integrations/github.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/app/konnect/service-catalog/integrations/github.md b/app/konnect/service-catalog/integrations/github.md index 61d548f36c3..3ff47f854d0 100644 --- a/app/konnect/service-catalog/integrations/github.md +++ b/app/konnect/service-catalog/integrations/github.md @@ -34,9 +34,9 @@ Repository | A GitHub repository relating to the service ## Events -The Eventing feature supports viewing the following event types for linked repositories from the {{site.konnect_product_name}} UI. +This integration supports events. -Event types: +You can view the following event types for linked repositories from the {{site.konnect_product_name}} UI: * Open pull request * Merge pull request