Skip to content

Commit

Permalink
add missing descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
lmilan authored and fabianrbz committed Nov 19, 2024
1 parent c9ebf91 commit d37e86c
Show file tree
Hide file tree
Showing 46 changed files with 95 additions and 20 deletions.
1 change: 1 addition & 0 deletions app/_landing_pages/authentication.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
metadata:
title: "Authentication"
content_type: landing_page
description: This page is an introduction to authentication with Kong.
tags:
- authentication
rows:
Expand Down
1 change: 1 addition & 0 deletions app/_landing_pages/custom-plugins.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
metadata:
title: Custom Plugins
content_type: landing_page
description: This page is an introduction to custom plugins for Kong.

rows:
- header:
Expand Down
1 change: 1 addition & 0 deletions app/_landing_pages/deck.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
metadata:
title: decK
content_type: landing_page
description: This page is an introduction to decK, a command line tool for API Lifecycle Automation.
rows:
- header:
type: h1
Expand Down
1 change: 1 addition & 0 deletions app/_landing_pages/gateway.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
metadata:
title: Kong Gateway
content_type: landing_page
description: This page is an introduction to Kong Gateway.
rows:
- header:
type: h1
Expand Down
1 change: 1 addition & 0 deletions app/_landing_pages/gateway/enterprise-vs-oss.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
metadata:
title: Kong Gateway Open Source vs Enterprise
content_type: landing_page
description: This page lists the different Kong Gateway features for each tier.
breadcrumbs:
- /gateway/
rows:
Expand Down
1 change: 1 addition & 0 deletions app/_landing_pages/gateway/entities.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
metadata:
title: Gateway Entities
content_type: landing_page
description: This page lists the different entities that make up Kong Gateway.
breadcrumbs:
- /gateway/
rows:
Expand Down
1 change: 1 addition & 0 deletions app/_landing_pages/gateway/rate-limiting.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
metadata:
title: Gateway Rate Limiting
content_type: landing_page
description: This page is an introduction to rate limiting with Kong Gateway.
breadcrumbs:
- /rate-limiting/

Expand Down
1 change: 1 addition & 0 deletions app/_landing_pages/inso-cli.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
metadata:
title: Inso CLI
content_type: landing_page
description: This page is an introduction to Inso CLI, a command line tool for Insomnia.
breadcrumbs:
- /insomnia/
rows:
Expand Down
1 change: 1 addition & 0 deletions app/_landing_pages/insomnia.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ metadata:
title: Insomnia
product: insomnia
content_type: landing_page
description: This page is an introduction to Insomnia.
rows:
- header:
type: h1
Expand Down
1 change: 1 addition & 0 deletions app/_landing_pages/insomnia/collections.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
metadata:
title: Collections
content_type: landing_page
description: This page is an introduction to request collections in Insomnia
breadcrumbs:
- /insomnia/
rows:
Expand Down
1 change: 1 addition & 0 deletions app/_landing_pages/insomnia/design.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
metadata:
title: Design APIs
content_type: landing_page
description: This page is an introduction to API design in Insomnia.
breadcrumbs:
- /insomnia/
rows:
Expand Down
1 change: 1 addition & 0 deletions app/_landing_pages/insomnia/documents.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
metadata:
title: Documents
content_type: landing_page
description: This page is an introduction to design documents in Insomnia.
breadcrumbs:
- /insomnia/
rows:
Expand Down
1 change: 1 addition & 0 deletions app/_landing_pages/insomnia/mock-servers.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
metadata:
title: Mocks
content_type: landing_page
description: This page is an introduction to mock servers in Insomnia.
breadcrumbs:
- /insomnia/
rows:
Expand Down
1 change: 1 addition & 0 deletions app/_landing_pages/insomnia/plugins.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
metadata:
title: Insomnia Plugins
content_type: landing_page
description: This page is an introduction to Insomnia plugins.
rows:
- header:
type: h1
Expand Down
1 change: 1 addition & 0 deletions app/_landing_pages/insomnia/security.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
metadata:
title: Security at Insomnia
content_type: landing_page
description: This page is an introduction to security with Insomnia.
rows:
- header:
type: h1
Expand Down
1 change: 1 addition & 0 deletions app/_landing_pages/insomnia/sso.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
metadata:
title: Insomnia SSO
content_type: landing_page
description: This page is an introduction to SSO for Insomnia.
rows:
- header:
type: h1
Expand Down
1 change: 1 addition & 0 deletions app/_landing_pages/insomnia/storage-options.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
metadata:
title: Insomnia Storage Options
content_type: landing_page
description: This page is an introduction to storage options in Insomnia.
rows:
- header:
type: h1
Expand Down
1 change: 1 addition & 0 deletions app/_landing_pages/insomnia/test.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
metadata:
title: Test APIs
content_type: landing_page
description: This page is an introduction to API testing in Insomnia.
breadcrumbs:
- /insomnia/
rows:
Expand Down
1 change: 1 addition & 0 deletions app/_landing_pages/kic/rate-limiting.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
metadata:
title: KIC Rate Limiting
content_type: landing_page
description: This page is an introduction to rate limiting in with Kong Ingress Controller.
breadcrumbs:
- /rate-limiting/
rows:
Expand Down
1 change: 1 addition & 0 deletions app/_landing_pages/mesh/rate-limiting.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
metadata:
title: Mesh Rate Limiting
content_type: landing_page
description: This page is an introduction to rate limiting in with Kong Mesh.
breadcrumbs:
- /rate-limiting/
rows:
Expand Down
1 change: 1 addition & 0 deletions app/_landing_pages/rate-limiting.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
metadata:
title: "Rate Limiting"
content_type: landing_page
description: This page is an introduction to rate limiting with Kong.
tags:
- rate-limiting
rows:
Expand Down
5 changes: 3 additions & 2 deletions app/deck/distributed-config.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Distributed Configuration for Kong using decK

description: decK can operate on a subset of configuration instead of managing the entire configuration of Kong Gateway.

content_type: reference
layout: reference

Expand All @@ -18,8 +20,7 @@ breadcrumbs:
- /deck/
---

decK can operate on a subset of configuration instead of
managing the entire configuration of {{site.base_gateway}}.
{{ page.description }}
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
Expand Down
4 changes: 3 additions & 1 deletion app/deck/environment-variables.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Using environment variables with decK

description: decK allows you to manage values in decK files using environment variables.

content_type: reference
layout: reference

Expand All @@ -18,7 +20,7 @@ breadcrumbs:
- /deck/
---

To manage any values in decK files with environment varaibles, you can create environment variables
To manage any values in decK files with environment variables, you can create environment variables
with the `DECK_` prefix and reference them as `{%raw%}${{ env "DECK_*" }}{%endraw%}` in your state file.

When you use decK to apply configurations to {{site.base_gateway}},
Expand Down
5 changes: 3 additions & 2 deletions app/deck/manage-deck-with-docker.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Manage decK with Docker

description: If you used the [kong/deck](https://hub.docker.com/r/kong/deck) Docker image to install decK, you can use the same Docker image to manage decK.

content_type: reference
layout: reference

Expand All @@ -21,8 +23,7 @@ breadcrumbs:
- /deck/
---

If you used the [kong/deck](https://hub.docker.com/r/kong/deck) Docker image to
install decK, you can use the same Docker image to manage decK.
{{ page.description }}

Adjust `KONG_ADMIN_HOST` and the port `8001` in the following examples to the
host and port of your own {{site.base_gateway}} instance.
Expand Down
5 changes: 3 additions & 2 deletions app/deck/object-defaults.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Object defaults reference

description: Kong Gateway sets some default values for most objects, including Kong plugins.

content_type: reference
layout: reference

Expand All @@ -22,8 +24,7 @@ breadcrumbs:
- /deck/
---

Kong Gateway sets some default values for most objects, including Kong
plugins. You can see what the defaults are for each object in the
{{ page.description }} You can see what the defaults are for each object in the
[Admin API reference](/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 Kong Gateway.
Expand Down
8 changes: 5 additions & 3 deletions app/gateway/rate-limiting/strategies.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Rate Limiting Strategies

description: This page describes the rate limiting strategies supported by Kong Gateway plugins.

content_type: reference
layout: reference

Expand All @@ -23,9 +25,9 @@ All rate limiting plugins support some subset of the following strategies:

| Strategy | Pros | Cons | Supported in plugin |
| --------- | ---- | ------ | ------------------- |
| `local` | Minimal performance impact. | Less accurate. Unless there's a consistent-hashing load balancer in front of Kong, it diverges when scaling the number of nodes. | AI Rate Limiting Advanced <br> Rate Limiting Advanced <br> Rate Limiting <br> Response Ratelimiting |
| `cluster` | Accurate<sup>1</sup>, no extra components to support. | Each request forces a read and a write on the data store. Therefore, relatively, the biggest performance impact. | AI Rate Limiting Advanced <br> Rate Limiting Advanced <br> Rate Limiting <br> Response Ratelimiting <br> GraphQL Rate Limiting Advanced |
| `redis` | Accurate<sup>1</sup>, less performance impact than a `cluster` policy. | Needs a Redis installation. Bigger performance impact than a `local` policy. | AI Rate Limiting Advanced <br> Rate Limiting Advanced <br> Rate Limiting <br> Response Ratelimiting <br> GraphQL Rate Limiting Advanced |
| `local` | Minimal performance impact. | Less accurate. Unless there's a consistent-hashing load balancer in front of Kong, it diverges when scaling the number of nodes. | AI Rate Limiting Advanced <br> Rate Limiting Advanced <br> Rate Limiting <br> Response Rate Limiting |
| `cluster` | Accurate<sup>1</sup>, no extra components to support. | Each request forces a read and a write on the data store. Therefore, relatively, the biggest performance impact. | AI Rate Limiting Advanced <br> Rate Limiting Advanced <br> Rate Limiting <br> Response Rate Limiting <br> GraphQL Rate Limiting Advanced |
| `redis` | Accurate<sup>1</sup>, less performance impact than a `cluster` policy. | Needs a Redis installation. Bigger performance impact than a `local` policy. | AI Rate Limiting Advanced <br> Rate Limiting Advanced <br> Rate Limiting <br> Response Rate Limiting <br> GraphQL Rate Limiting Advanced |

<!--
Expand Down
2 changes: 2 additions & 0 deletions app/gateway/rate-limiting/window-types.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Rate Limiting Window Types

description: This page describes the rate limiting window types supported by Kong Gateway plugins.

content_type: reference
layout: reference

Expand Down
4 changes: 3 additions & 1 deletion app/gateway/routing/expressions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Expressions router

description: Kong Gateway includes a rule-based engine using a domain-specific expressions language.

content_type: reference
layout: reference

Expand All @@ -20,7 +22,7 @@ breadcrumbs:
- /gateway/routing/
---

{{site.base_gateway}} includes a rule-based engine using a domain-specific expressions language. Expressions can be used to perform tasks such as defining
{{ page.description }} 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.

Expand Down
2 changes: 2 additions & 0 deletions app/gateway/routing/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Routing in Kong Gateway

description: This page explains how routing works in Kong Gateway.

content_type: reference
layout: reference

Expand Down
5 changes: 4 additions & 1 deletion app/insomnia/api-specs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: API specs in Insomnia

description: API specifications explain how an API behaves and how it interacts with other APIs.

content_type: concept
layout: concept

Expand Down Expand Up @@ -42,7 +44,8 @@ breadcrumbs:

## What are API specs?

API specifications explain how an API behaves and how it interacts with other APIs. 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.
{{ page.description }}
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?

Expand Down
5 changes: 4 additions & 1 deletion app/insomnia/cloud-sync.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Cloud sync

description: Cloud sync enables users to store and synchronize their project data in the cloud securely as well as use [version control](/insomnia/version-control).

content_type: concept
layout: concept

Expand Down Expand Up @@ -31,7 +33,8 @@ faqs:

---

Cloud sync enables users to store and synchronize their project data in the cloud securely as well as use [version control](/insomnia/version-control). This feature is beneficial for collaboration, providing easy access to projects from different devices and locations.
{{page.description}}
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:
* Commit and push the contents of projects
Expand Down
2 changes: 2 additions & 0 deletions app/insomnia/collected-data.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Collected data

description: Insomnia collects usage analytics data to help improve the application.

content_type: reference
layout: reference

Expand Down
2 changes: 2 additions & 0 deletions app/insomnia/concepts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Insomnia concepts

description: This page defines some concepts related to Insomnia.

content_type: reference
layout: reference

Expand Down
4 changes: 3 additions & 1 deletion app/insomnia/data-security.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Data security

description: All Insomnia project data is encrypted end-to-end (E2EE).

content_type: reference
layout: reference

Expand Down Expand Up @@ -28,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.
---

All Insomnia project data is encrypted end-to-end (E2EE). 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 }} 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).

Expand Down
6 changes: 5 additions & 1 deletion app/insomnia/git-sync.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: Git sync

description: Git sync allows users to use a third-party Git repository for storing project data.

content_type: concept
layout: concept

Expand Down Expand Up @@ -36,7 +39,8 @@ faqs:

---

Git sync allows users to use a third-party Git repository for storing project data. This option is independent of cloud access and is suitable for users familiar with Git workflows.
{{ page.description }}
This option is independent of cloud access and is suitable for users familiar with Git workflows.

Key features:
* **Version control:** Leverage Git’s [version control](/insomnia/version-control) capabilities for your projects.
Expand Down
Loading

0 comments on commit d37e86c

Please sign in to comment.