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.

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

QA (landing pages & reference) #187

Merged
merged 2 commits into from
Dec 20, 2024
Merged

QA (landing pages & reference) #187

merged 2 commits into from
Dec 20, 2024

Conversation

lmilan
Copy link
Contributor

@lmilan lmilan commented Dec 20, 2024

Preview Links

Checklist

  • Every page is page one
  • Tested how-to docs. If not, note why here.
  • All pages contain metadata
  • Updated sources.yaml. For more info review track docs changes
  • Any new docs link to existing docs.

@lmilan lmilan requested a review from a team as a code owner December 20, 2024 15:01
Copy link

netlify bot commented Dec 20, 2024

Deploy Preview for kongdeveloper ready!

Name Link
🔨 Latest commit a900870
🔍 Latest deploy log https://app.netlify.com/sites/kongdeveloper/deploys/6765876998b57600085fdfe8
😎 Deploy Preview https://deploy-preview-187--kongdeveloper.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@cloudjumpercat cloudjumpercat self-requested a review December 20, 2024 15:12
@cloudjumpercat cloudjumpercat self-assigned this Dec 20, 2024
Copy link
Contributor

@cloudjumpercat cloudjumpercat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving so you're not blocked, but I left several suggested changes.

@@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{ page.description | liquify }} Consumers can be applications, services, or users who interact with your APIs.
A Consumer typically refers to an entity that consumes or uses the APIs managed by {{site.base_gateway}}. Consumers can be applications, services, or users who interact with your APIs.

Fabian recommended just putting the description directly in the intro paragraph on one of my other PRs.

@@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{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.
A route is a path to a resource within an upstream application. 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.

@@ -34,7 +34,7 @@ api_specs:

## What is a Gateway Service?

{{ page.description }}
{{ page.description | liquify }}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{ page.description | liquify }}
A Gateway Service is an abstraction of an upstream application that services requests.

@@ -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`).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{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`).
A Target is an IP address/hostname with a port that identifies an instance of a backend service. 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`).

@@ -20,7 +20,7 @@ breadcrumbs:
- /deck/
---

{{ page.description }}
{{ page.description | liquify }}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{ page.description | liquify }}
decK can operate on a subset of configuration instead of managing the entire configuration of {{site.base_gateway}}.

{{ page.description | liquify }}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{ page.description | liquify }}
We monitor the security of our products and applications through various ongoing activities, including logs.

@@ -31,7 +31,7 @@ faqs:

---

{{ page.description }}
{{ page.description | liquify }}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{ page.description | liquify }}
Local vault is a storage option that allows all project data to be stored locally on your device.

@@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{ 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.
Scratch pad is a storage option that allows all project data to be stored locally on your device. This option is ideal for users who prefer or require their data to remain off the cloud for privacy or security reasons.

@@ -21,7 +21,7 @@ related_resources:

---

{{ page.description }}
{{ page.description | liquify }}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{ page.description | liquify }}
Insomnia offers various storage options to cater to different user needs and preferences.

@@ -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 }}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{ page.description | liquify }}
Insomnia allows you to manage versions of collections, mock servers, design documents, and global environments in Insomnia, both with cloud sync and git sync.

@lmilan lmilan merged commit 26f3894 into main Dec 20, 2024
10 checks passed
@lmilan lmilan deleted the qa branch December 20, 2024 16:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants