From 9be3153522ae168e661c73578c42c610fe578bc6 Mon Sep 17 00:00:00 2001 From: Lucie Milan Date: Fri, 20 Dec 2024 16:00:39 +0100 Subject: [PATCH 1/2] QA --- app/_gateway_entities/consumer.md | 2 +- app/_gateway_entities/route.md | 2 +- app/_gateway_entities/service.md | 2 +- app/_gateway_entities/target.md | 2 +- app/_gateway_entities/workspace.md | 2 ++ app/_includes/plugins/ai-proxy/overview.md | 2 +- app/_landing_pages/gateway.yaml | 6 +++--- app/_landing_pages/gateway/rate-limiting.yaml | 2 +- app/_landing_pages/kic/rate-limiting.yaml | 2 +- app/_landing_pages/mesh/rate-limiting.yaml | 2 +- app/deck/distributed-config.md | 2 +- app/deck/manage-deck-with-docker.md | 2 +- app/deck/object-defaults.md | 6 +++--- app/gateway/routing/expressions.md | 2 +- app/index.html | 20 +++++++++---------- app/insomnia/api-specs.md | 2 +- app/insomnia/cloud-sync.md | 2 +- app/insomnia/data-security.md | 2 +- app/insomnia/git-sync.md | 2 +- app/insomnia/incident-response.md | 2 +- app/insomnia/local-vault.md | 2 +- app/insomnia/scratch-pad.md | 2 +- app/insomnia/storage.md | 2 +- app/insomnia/version-control.md | 2 +- 24 files changed, 38 insertions(+), 36 deletions(-) diff --git a/app/_gateway_entities/consumer.md b/app/_gateway_entities/consumer.md index e556ead6a..9f3e5f86a 100644 --- a/app/_gateway_entities/consumer.md +++ b/app/_gateway_entities/consumer.md @@ -78,7 +78,7 @@ schema: ## What is a Consumer? -{{ page.description }} Consumers can be applications, services, or users who interact with your APIs. +{{ page.description | liquify }} Consumers can be applications, services, or users who interact with your APIs. Since they are not always human, {{site.base_gateway}} calls them Consumers, because they "consume" the service. {{site.base_gateway}} allows you to define and manage Consumers, apply access control policies, and monitor their API usage. diff --git a/app/_gateway_entities/route.md b/app/_gateway_entities/route.md index 935dfe998..92e9396d5 100644 --- a/app/_gateway_entities/route.md +++ b/app/_gateway_entities/route.md @@ -29,7 +29,7 @@ schema: ## What is a route? -{{page.description}} Services can store collections of objects like plugin configurations, and policies, and they can be associated with routes. In {{site.base_gateway}}, routes typically map to endpoints that are exposed through the {{site.base_gateway}} application. Routes can also define rules that match requests to associated services. Because of this, one route can reference multiple endpoints. A basic route should have a name, path or paths, and reference an existing service. +{{page.description | liquify}} Services can store collections of objects like plugin configurations, and policies, and they can be associated with routes. In {{site.base_gateway}}, routes typically map to endpoints that are exposed through the {{site.base_gateway}} application. Routes can also define rules that match requests to associated services. Because of this, one route can reference multiple endpoints. A basic route should have a name, path or paths, and reference an existing service. You can also configure routes with: diff --git a/app/_gateway_entities/service.md b/app/_gateway_entities/service.md index 60f704ead..fca2ed1df 100644 --- a/app/_gateway_entities/service.md +++ b/app/_gateway_entities/service.md @@ -34,7 +34,7 @@ api_specs: ## What is a Gateway Service? -{{ page.description }} +{{ page.description | liquify }} Services can store collections of objects like plugin configurations, and policies, and they can be associated with routes. When defining a Service, the administrator provides a name and the upstream application connection information. diff --git a/app/_gateway_entities/target.md b/app/_gateway_entities/target.md index 3c9149647..4a22dc5e6 100644 --- a/app/_gateway_entities/target.md +++ b/app/_gateway_entities/target.md @@ -27,7 +27,7 @@ schema: ## What is a Target? -{{page.description}} Each [Upstream](/gateway/entities/upstream/) can have many Targets. Targets are used by Upstreams for [load balancing](https://docs.konghq.com/gateway/latest/how-kong-works/load-balancing/). For example, if you have an `example_upstream` Upstream, you can point it to two different Targets: `httpbin.konghq.com` and `httpbun.com`. This is so that if one of the servers (like `httpbin.konghq.com`) is unavailable, it automatically detects the problem and routes all traffic to the working server (`httpbun.com`). +{{page.description | liquify}} Each [Upstream](/gateway/entities/upstream/) can have many Targets. Targets are used by Upstreams for [load balancing](https://docs.konghq.com/gateway/latest/how-kong-works/load-balancing/). For example, if you have an `example_upstream` Upstream, you can point it to two different Targets: `httpbin.konghq.com` and `httpbun.com`. This is so that if one of the servers (like `httpbin.konghq.com`) is unavailable, it automatically detects the problem and routes all traffic to the working server (`httpbun.com`). The following diagram illustrates how Targets are used by Upstreams for load balancing: diff --git a/app/_gateway_entities/workspace.md b/app/_gateway_entities/workspace.md index 64f5d982a..8dd64fb7a 100644 --- a/app/_gateway_entities/workspace.md +++ b/app/_gateway_entities/workspace.md @@ -18,6 +18,8 @@ schema: path: /schemas/Workspace --- +TODO + ## What is a workspace? This page is a stub diff --git a/app/_includes/plugins/ai-proxy/overview.md b/app/_includes/plugins/ai-proxy/overview.md index 59907e3d0..e8b1aef92 100644 --- a/app/_includes/plugins/ai-proxy/overview.md +++ b/app/_includes/plugins/ai-proxy/overview.md @@ -7,7 +7,7 @@ {% assign options = include.params.options %} {% assign providers = site.data.plugins.ai-proxy.providers %} -{{ page.description }} +{{ page.description | liquify }} The plugin accepts requests in one of a few defined and standardized formats, translates them to the configured target format, and then transforms the response back into a standard format. diff --git a/app/_landing_pages/gateway.yaml b/app/_landing_pages/gateway.yaml index 297177c5c..1345a356d 100644 --- a/app/_landing_pages/gateway.yaml +++ b/app/_landing_pages/gateway.yaml @@ -47,9 +47,9 @@ rows: PostgreSQL database. Pass the `-- -h` option to the script to see all possible configuration options, including how to pass a license - to the script, how to switch to an open-source Gateway image, enable RBAC, and more. + to the script, switch to an open-source Gateway image, enable RBAC, and more. - Visit the [Gateway install page](/gateway/install/) for all other installation options. + Visit the [Gateway install page](https://docs.konghq.com/gateway/latest/install/) for all other installation options. - header: type: h2 @@ -101,7 +101,7 @@ rows: oss: true enterprise: true - title: Gateway Mocking - subtitle: Mock API responses directly on the API gateway. + subtitle: Mock API responses directly on the API gateway oss: false enterprise: true - title: "Kong Manager: Admin GUI" diff --git a/app/_landing_pages/gateway/rate-limiting.yaml b/app/_landing_pages/gateway/rate-limiting.yaml index a343cc7ab..2b719ec53 100644 --- a/app/_landing_pages/gateway/rate-limiting.yaml +++ b/app/_landing_pages/gateway/rate-limiting.yaml @@ -22,7 +22,7 @@ rows: text: | {{site.base_gateway}} allows you to limit how many HTTP requests can be made in a given period. - Rate limits can be applied to a [service](/gateway/entities/service/) or individual [routes](/gateway/entities/route/) to protect the upstream API, or to a [consumer](/gateway/entities/consumer/) to restrict how many times a user can call the API in the specified period. + Rate limits can be applied to a [Gateway Service](/gateway/entities/service/) or individual [Routes](/gateway/entities/route/) to protect the upstream API, or to a [Consumer](/gateway/entities/consumer/) to restrict how many times a user can call the API in the specified period. Kong offers two standard HTTP rate limiting plugins: [Rate Limiting](/plugins/rate-limiting) or [Rate Limiting Advanced](/plugins/rate-limiting-advanced) plugins in addition to a series [specialized](#specialized-rate-limiting-plugins) AI, GraphQL and dynamic rate limiting plugins. - columns: diff --git a/app/_landing_pages/kic/rate-limiting.yaml b/app/_landing_pages/kic/rate-limiting.yaml index 1bbf55789..060254e1e 100644 --- a/app/_landing_pages/kic/rate-limiting.yaml +++ b/app/_landing_pages/kic/rate-limiting.yaml @@ -8,7 +8,7 @@ rows: - header: type: h1 text: "Rate Limiting with {{site.kic_product_name}}" - +# TODO - header: type: h2 text: How-to Guides diff --git a/app/_landing_pages/mesh/rate-limiting.yaml b/app/_landing_pages/mesh/rate-limiting.yaml index 7fb6f9aec..7593d77f3 100644 --- a/app/_landing_pages/mesh/rate-limiting.yaml +++ b/app/_landing_pages/mesh/rate-limiting.yaml @@ -8,7 +8,7 @@ rows: - header: type: h1 text: "Rate Limiting with {{site.mesh_product_name}}" - +#TODO - header: type: h2 text: How-to Guides diff --git a/app/deck/distributed-config.md b/app/deck/distributed-config.md index b0f5a98f9..8a846d989 100644 --- a/app/deck/distributed-config.md +++ b/app/deck/distributed-config.md @@ -20,7 +20,7 @@ breadcrumbs: - /deck/ --- -{{ page.description }} +{{ page.description | liquify }} You can do this by breaking up the configuration into multiple files and managing them using tags. With tags, you can use decK's `select-tag` feature to export, sync, or reset diff --git a/app/deck/manage-deck-with-docker.md b/app/deck/manage-deck-with-docker.md index 723ee7eff..6b6123446 100644 --- a/app/deck/manage-deck-with-docker.md +++ b/app/deck/manage-deck-with-docker.md @@ -23,7 +23,7 @@ breadcrumbs: - /deck/ --- -{{ page.description }} +{{ page.description | liquify }} Adjust `KONG_ADMIN_HOST` and the port `8001` in the following examples to the host and port of your own {{site.base_gateway}} instance. diff --git a/app/deck/object-defaults.md b/app/deck/object-defaults.md index 7aba1bd63..ec9ddf4a0 100644 --- a/app/deck/object-defaults.md +++ b/app/deck/object-defaults.md @@ -24,7 +24,7 @@ breadcrumbs: - /deck/ --- -{{ page.description }} You can see what the defaults are for each object in the +{{ page.description | liquify }} You can see what the defaults are for each object in the [Admin API reference](https://docs.konghq.com/gateway/latest/admin-api/), or use the [`/schemas`](#find-defaults-for-an-object) endpoint to check the latest object schemas for your instance of the {{site.base_gateway}}. @@ -45,7 +45,7 @@ enforce a set of standard values and avoid repetition in your configuration. decK assigns values in the following order of precedence, from highest to lowest: 1. Values set for a specific instance of an object in the state file -(for example, for a service named `example_service` defined in `kong.yml`). +(for example, for a Gateway Service named `example_service` defined in `kong.yaml`). 2. Values set in the `{_info: defaults:}` object in the state file. 3. Self-managed {{site.base_gateway}} only: Values are checked against the Kong Admin API schemas. @@ -237,7 +237,7 @@ For all available properties, see the Use the Kong Admin API `/schemas` endpoint to find default values: ```sh -curl -i http://localhost:8001/schemas/plugins/ +curl -i http://localhost:8001/schemas/plugins/$PLUGIN_NAME ``` decK doesn't support setting custom default values for the plugin object. diff --git a/app/gateway/routing/expressions.md b/app/gateway/routing/expressions.md index e6be42c30..9edd79471 100644 --- a/app/gateway/routing/expressions.md +++ b/app/gateway/routing/expressions.md @@ -22,7 +22,7 @@ breadcrumbs: - /gateway/routing/ --- -{{ page.description }} Expressions can be used to perform tasks such as defining +{{ page.description | liquify }} Expressions can be used to perform tasks such as defining complex routing logic. This guide is a reference for the expressions language and explains how it can be used. diff --git a/app/index.html b/app/index.html index 45e269c48..e822eef9f 100644 --- a/app/index.html +++ b/app/index.html @@ -51,7 +51,7 @@

Gateway

Overview → - Install → + Install → How-to Guides →
@@ -62,8 +62,8 @@

Mesh

Secure and control traffic with Kong Mesh's distributed service mesh capabilities.

- Overview → - Install → + Overview → + Install → How-to Guides →
@@ -74,8 +74,8 @@

KIC

Kong’s Kubernetes-native controller to manage API traffic for containerized apps.

- Overview → - Install → + Overview → + Install → How-to Guides →
@@ -92,7 +92,7 @@

Portal

Empower API consumers with self-service API documentation and developer tools.

- Overview → + Overview → Use Cases → How-to Guides →
@@ -104,7 +104,7 @@

Analytics

Gain visibility into API performance and usage patterns with Kong's analytics.

- Overview → + Overview → Use Cases → How-to Guides →
@@ -116,7 +116,7 @@

Service Catalog

Manage and discover services within the Kong ecosystem effortlessly.

- Overview → + Overview → Use Cases → How-to Guides →
@@ -133,7 +133,7 @@

Org Management

Streamline and govern organization-wide API access and operations.

- Overview → + Overview → Use Cases → How-to Guides →
@@ -145,7 +145,7 @@

Auditing

Streamline and govern organization-wide API access and operations.

- Overview → + Overview → Use Cases → How-to Guides →
diff --git a/app/insomnia/api-specs.md b/app/insomnia/api-specs.md index 2f5a6d6c1..334d49bbf 100644 --- a/app/insomnia/api-specs.md +++ b/app/insomnia/api-specs.md @@ -44,7 +44,7 @@ breadcrumbs: ## What are API specs? -{{ page.description }} +{{ page.description | liquify }} API specs can function like API documentation, but they also explain the values, parameters, and objects in the schema of the API. An API spec helps users know how to make requests to the APIs contained within the spec. ## How does Insomnia parse API specs? diff --git a/app/insomnia/cloud-sync.md b/app/insomnia/cloud-sync.md index 5da1b0e80..485deba9d 100644 --- a/app/insomnia/cloud-sync.md +++ b/app/insomnia/cloud-sync.md @@ -33,7 +33,7 @@ faqs: --- -{{page.description}} +{{page.description | liquify}} This feature is beneficial for collaboration, providing easy access to projects from different devices and locations. Cloud sync provides the following abilities on top of the base Insomnia functionality: diff --git a/app/insomnia/data-security.md b/app/insomnia/data-security.md index c10a9f9cb..9bde7dae0 100644 --- a/app/insomnia/data-security.md +++ b/app/insomnia/data-security.md @@ -30,7 +30,7 @@ faqs: a: The ability to share Resource Groups is the reason that every Resource Group needs its own key, and every account needs a public/private key-pair to securely share said key. Here’s an example involving two users, Jane and Bob. For Jane to share a Resource Group with Bob, she must encrypt the Resource Group’s key with Bob’s public key and store it on the server (M_Link). Now, Bob can use his account’s private key to decrypt the Resource Group’s key and gain access to the data. This is a classic example of the Diffie-Hellman key exchange being put to good use. --- -{{ page.description }} E2EE means that all encryption keys are generated locally, all encryption is performed before sending any data over the network, and all decryption is performed after receiving data from the network. At no point in the sync process can the Insomnia servers, or an intruder read or access sensitive application project data. +{{ page.description | liquify }} E2EE means that all encryption keys are generated locally, all encryption is performed before sending any data over the network, and all decryption is performed after receiving data from the network. At no point in the sync process can the Insomnia servers, or an intruder read or access sensitive application project data. Insomnia data is stored in a pooled model for multi-tenancy. Each row is separated by a tenant identifier within the database. To retrieve data, the Insomnia Admin API request must have the tenant identifier (organization ID) in the request path and an authenticated user who is a member of the target tenant (organization). diff --git a/app/insomnia/git-sync.md b/app/insomnia/git-sync.md index b8f2a2663..196a6f0a2 100644 --- a/app/insomnia/git-sync.md +++ b/app/insomnia/git-sync.md @@ -39,7 +39,7 @@ faqs: --- -{{ page.description }} +{{ page.description | liquify }} This option is independent of cloud access and is suitable for users familiar with Git workflows. Key features: diff --git a/app/insomnia/incident-response.md b/app/insomnia/incident-response.md index fad00585a..d83178bf9 100644 --- a/app/insomnia/incident-response.md +++ b/app/insomnia/incident-response.md @@ -26,4 +26,4 @@ faqs: a: Our [open source GitHub repository](https://github.com/kong/insomnia) and [support channels](https://insomnia.rest/support). --- -{{ page.description }} \ No newline at end of file +{{ page.description | liquify }} \ No newline at end of file diff --git a/app/insomnia/local-vault.md b/app/insomnia/local-vault.md index 871c15b44..cf291c56b 100644 --- a/app/insomnia/local-vault.md +++ b/app/insomnia/local-vault.md @@ -31,7 +31,7 @@ faqs: --- -{{ page.description }} +{{ page.description | liquify }} This option is ideal for users who prefer or require their data to remain off the cloud for privacy or security reasons. Key features: diff --git a/app/insomnia/scratch-pad.md b/app/insomnia/scratch-pad.md index 86de8e303..80ddbac30 100644 --- a/app/insomnia/scratch-pad.md +++ b/app/insomnia/scratch-pad.md @@ -29,7 +29,7 @@ faqs: a: In both local vault and scratch pad, project data is stored locally. With local vault, you can also use git sync. In scratch pad, all data is stored locally, so it is best suited for individual developers who aren't working as part of a team. --- -{{ page.description }} This option is ideal for users who prefer or require their data to remain off the cloud for privacy or security reasons. +{{ page.description | liquify }} This option is ideal for users who prefer or require their data to remain off the cloud for privacy or security reasons. Key features: * **Local storage:** All project files are stored on your local machine. diff --git a/app/insomnia/storage.md b/app/insomnia/storage.md index c3796f403..82c27d131 100644 --- a/app/insomnia/storage.md +++ b/app/insomnia/storage.md @@ -21,7 +21,7 @@ related_resources: --- -{{ page.description }} +{{ page.description | liquify }} Understanding these options is crucial for efficient and secure management of your API projects. This document outlines the three primary storage options available in Insomnia: Local Vault, Cloud Sync, and Git Sync. | You have... | Then use... | diff --git a/app/insomnia/version-control.md b/app/insomnia/version-control.md index 9e70ac1cc..621cf14fa 100644 --- a/app/insomnia/version-control.md +++ b/app/insomnia/version-control.md @@ -44,7 +44,7 @@ faqs: a: If you invite them to your organization or workspace, other users can edit the same Insomnia entities and use the same branches for version control. --- -{{ page.description }} +{{ page.description | liquify }} Branches are object-specific, meaning that the branches you have in a collection are specific to that one collection. They aren't shared with other collections or other objects, like a mock server. With cloud sync, versions are managed only in the Insomnia UI and can be shared with other users you've invited to your workspace. In git sync, you can pull branches from your repository into Insomnia and can also push local branches you make in Insomnia to your repository. From a90087072646335f1aef897f3d96a966b102d90e Mon Sep 17 00:00:00 2001 From: Lucie Milan Date: Fri, 20 Dec 2024 16:04:04 +0100 Subject: [PATCH 2/2] Update protocols.md --- app/plugins/protocols.md | 1 + 1 file changed, 1 insertion(+) diff --git a/app/plugins/protocols.md b/app/plugins/protocols.md index 724649e55..efff445f8 100644 --- a/app/plugins/protocols.md +++ b/app/plugins/protocols.md @@ -16,3 +16,4 @@ related_resources: breadcrumbs: - /gateway/ --- +TODO \ No newline at end of file