Skip to content

Commit

Permalink
Fix: Make Service Catalog a variable (#7645)
Browse files Browse the repository at this point in the history
* DOCU-3997

* renamed variable
  • Loading branch information
lmilan authored and Guaris committed Aug 26, 2024
1 parent 1d5d5c8 commit 96ef7cf
Show file tree
Hide file tree
Showing 10 changed files with 17 additions and 15 deletions.
2 changes: 1 addition & 1 deletion app/_includes/md/gateway/deployment-topologies.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!--vale off -->
{% mermaid %}
flowchart TD
A(Dev Portal &bull; Gateway Manager &bull; Analytics &bull; Service Catalog)
A(Dev Portal &bull; Gateway Manager &bull; Analytics &bull; {{site.service_catalog_name}})
B(<img src="/assets/images/logos/kogo-white.svg" style="max-height:20px" class="no-image-expand"/> Control plane \n #40;{{site.base_gateway}} instance#41;)
B2(<img src="/assets/images/logos/kogo-white.svg" style="max-height:20px" class="no-image-expand"/> Control plane \n #40;{{site.base_gateway}} instance#41;)
C(<img src="/assets/images/logos/KogoBlue.svg" style="max-height:20px" class="no-image-expand"/> Data plane 3\n #40;{{site.base_gateway}} instance#41;)
Expand Down
2 changes: 1 addition & 1 deletion app/_includes/md/konnect/deployment-topologies.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!--vale off -->
{% mermaid %}
flowchart TD
A(Dev Portal &bull; Gateway Manager &bull; Analytics &bull; Service Catalog)
A(Dev Portal &bull; Gateway Manager &bull; Analytics &bull; {{site.service_catalog_name}})
B(<img src="/assets/images/logos/kogo-white.svg" style="max-height:20px" class="no-image-expand"/> Kong-managed control plane \n #40;{{site.base_gateway}} instance#41;)
C(<img src="/assets/images/logos/KogoBlue.svg" style="max-height:20px" class="no-image-expand"/> Data plane 1\n #40;{{site.base_gateway}} instance#41;)
D(<img src="/assets/images/logos/KogoBlue.svg" style="max-height:20px" class="no-image-expand"/> Data plane 2\n #40;{{site.base_gateway}} instance#41;)
Expand Down
2 changes: 1 addition & 1 deletion app/_src/gateway/production/deployment-topologies/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The following sections briefly describe each mode.
{% include_cached /md/gateway/deployment-topologies.md topology='konnect' %}
<!-- vale on-->

> _Figure 1: In {{ site.konnect_short_name }}, Kong hosts your control planes and all of the related applications: Dev Portal, Gateway Manager, Analytics, Service Catalog, and so on. You attach data planes to {{ site.konnect_short_name }} to process traffic, which get all of their configuration from the control planes._
> _Figure 1: In {{ site.konnect_short_name }}, Kong hosts your control planes and all of the related applications: Dev Portal, Gateway Manager, Analytics, {{site.service_catalog_name}}, and so on. You attach data planes to {{ site.konnect_short_name }} to process traffic, which get all of their configuration from the control planes._
Configuration changes can be made using the {{ site.konnect_short_name }} UI and configuration wizards, or applied in an automated way using [decK](/deck/latest/).

Expand Down
2 changes: 1 addition & 1 deletion app/contributing/word-choice.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Kong Mesh <br><br> Mesh | Kong's service mesh. Use "Kong Mesh" for the first men
Kuma | Kong's open-source service mesh. <br><br> ❌&nbsp; Do not use "Kong Kuma". This is an open-source project supported by the CNCF and maintained, not owned, by Kong.
Insomnia | Kong's open-source API client.
Dev Portal <br><br> Dev Portal, self-managed <br> Dev Portal, cloud | A module for sharing APIs and their specs with developers, and enabling the developers to create applications based on Gateway or Konnect services. <br><br> ❌&nbsp; Do not use "Developer Portal".
Service Catalog | The service catalog in Konnect. <br><br> ❌&nbsp; Do not use "Servicecatalog", "Service catalog", or "servicecatalog".
{{site.service_catalog_name}} | The service catalog in Konnect. <br><br> ❌&nbsp; Do not use "Servicecatalog", "Service catalog", or "servicecatalog".
Gateway Manager | The runtime management service in Konnect <br><br> ❌&nbsp; Do not use "Gateway manager" with lowercase "manager".
Analytics | Analytics and monitoring for Gateway and Konnect. <br><br> ❌&nbsp; Do not use "Vitals".
decK | Kong's CLI tool for managing declarative configuration.<br><br> ❌&nbsp; Do not capitalize the first letter, even if the name appears at the start of a sentence.
Expand Down
8 changes: 4 additions & 4 deletions app/konnect/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,12 @@ lightweight, fast, and flexible API gateway.
</div>
## {{site.konnect_short_name}} modules

### Service Catalog
### {{site.service_catalog_name}}

The [Service Catalog](/konnect/service-catalog) makes internal APIs discoverable,
consumable, and reusable for internal development teams. You can use the Service Catalog to monitor
The [{{site.service_catalog_name}}](/konnect/service-catalog) makes internal APIs discoverable,
consumable, and reusable for internal development teams. You can use the {{site.service_catalog_name}} to monitor
all your services and create a single source of
truth for your organization’s service inventory. By leveraging the Service Catalog,
truth for your organization’s service inventory. By leveraging the {{site.service_catalog_name}},
your application developers
can search, discover, and consume existing services to accelerate their
time-to-market, while enabling a more consistent end-user experience
Expand Down
6 changes: 3 additions & 3 deletions app/konnect/service-catalog/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ subtitle: Track every service across your architecture
content-type: explanation
---

A new Service Catalog experience is currently in development. The new Service Catalog will be a one-stop place to see all your services, with all your service information, right at your fingertips.
A new {{site.service_catalog_name}} experience is currently in development. The new {{site.service_catalog_name}} will be a one-stop place to see all your services, with all your service information, right at your fingertips.

If you would like to get early access to the new Service Catalog, go to **Service Catalog** in the sidebar of your {{site.konnect_short_name}} instance.
If you would like to get early access to the new {{site.service_catalog_name}}, go to **{{site.service_catalog_name}}** in the sidebar of your {{site.konnect_short_name}} instance.

## How to manage your services

While the new Service Catalog is in development, you can manage your services in the following ways:
While the new {{site.service_catalog_name}} is in development, you can manage your services in the following ways:

| Action | New location |
| ------ | ------------ |
Expand Down
6 changes: 3 additions & 3 deletions app/konnect/servicehub/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ subtitle: Track every service across your architecture
content-type: explanation
---

A new Service Catalog experience is currently in development. The new Service Catalog will be a one-stop place to see all your services, with all your service information, right at your fingertips.
A new {{site.service_catalog_name}} experience is currently in development. The new {{site.service_catalog_name}} will be a one-stop place to see all your services, with all your service information, right at your fingertips.

If you would like to get early access to the new Service Catalog, go to **Service Catalog** in the sidebar of your {{site.konnect_short_name}} instance.
If you would like to get early access to the new {{site.service_catalog_name}}, go to **{{site.service_catalog_name}}** in the sidebar of your {{site.konnect_short_name}} instance.

## How to manage your services

While the new Service Catalog is in development, you can manage your services in the following ways:
While the new {{site.service_catalog_name}} is in development, you can manage your services in the following ways:

| Action | New location |
| ------ | ------------ |
Expand Down
2 changes: 1 addition & 1 deletion app/konnect/updates.md
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,7 @@ You can upload a plugin schema to Konnect and get started with custom plugins in
: A new {{site.konnect_short_name}} API for managing API products and versions is now available for external consumption. This API allows you to create and manage API products and versions, upload documentation and specs, and link a version to an existing Gateway service to enable application registration. As a result, you can integrate this API into your automated pipeline to streamline publishing documentation for your products to your third-party developers. Explore the API spec on our [Developer Portal](/konnect/api/api-products/latest/)

**API Products**
: Introducing a new {{site.konnect_short_name}} module, [API Products](https://cloud.konghq.com/us/api-products/), where technical & non-technical audiences can document their services, link to Gateway services for application registration, and publish API Products to a Developer Portal for consumption. Existing {{site.konnect_short_name}} customers will find that their services in the Service Catalog have been seamlessly moved to the new API Products UI & API experience.
: Introducing a new {{site.konnect_short_name}} module, [API Products](https://cloud.konghq.com/us/api-products/), where technical & non-technical audiences can document their services, link to Gateway services for application registration, and publish API Products to a Developer Portal for consumption. Existing {{site.konnect_short_name}} customers will find that their services in the {{site.service_catalog_name}} have been seamlessly moved to the new API Products UI & API experience.

: **Note:** Tagging your Gateway services with `_KonnectService` doesn't automatically create an API product and API product version.

Expand Down
1 change: 1 addition & 0 deletions jekyll-dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,7 @@ company_name: Kong Inc.
mesh_product_name: Kong Mesh
deck_product_name: decK
contributing_product_name: Contribution Guidelines
service_catalog_name: Service Catalog
# Mesh specific config
mesh_namespace: kong-mesh-system
mesh_cp_name: kong-mesh-control-plane
Expand Down
1 change: 1 addition & 0 deletions jekyll.yml
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,7 @@ company_name: Kong Inc.
mesh_product_name: Kong Mesh
deck_product_name: decK
contributing_product_name: Contribution Guidelines
service_catalog_name: Service Catalog
# Mesh specific config
mesh_namespace: kong-mesh-system
mesh_cp_name: kong-mesh-control-plane
Expand Down

0 comments on commit 96ef7cf

Please sign in to comment.