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

Tools landing page #54

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Tools landing page #54

wants to merge 6 commits into from

Conversation

cloudjumpercat
Copy link
Contributor

@cloudjumpercat cloudjumpercat commented Aug 13, 2024

Created a landing page for Kong tools
https://deploy-preview-54--kongdeveloper.netlify.app/tools/

Copy link

netlify bot commented Aug 13, 2024

Deploy Preview for kongdeveloper ready!

Name Link
🔨 Latest commit c128443
🔍 Latest deploy log https://app.netlify.com/sites/kongdeveloper/deploys/66bf31c25d400400081bc6c2
😎 Deploy Preview https://deploy-preview-54--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
Copy link
Contributor Author

@lmilan Here's the tools landing page! Feel free to add or edit anything you'd like! I couldn't think of a lot of words to go on this page.

- type: mermaid
config:
alt_text: "A diagram that shows how various Kong tools work, with Konnect as an example"
diagram: |
Copy link
Member

Choose a reason for hiding this comment

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

What's the difference between Konnect and Konnect API?

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm guessing this is referring to the UI, but I'd like clarity on that too.

- column:
- type: card
config:
title: KIC
Copy link
Member

Choose a reason for hiding this comment

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

This is an interesting one. KIC is a tool, but it's also a product. I'd drop KIC for now

text: Tutorials
- type: tutorial_list
config:
- tag: deck
Copy link
Collaborator

Choose a reason for hiding this comment

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

This won't work with the current implementation, but we can change that :)

config:
  - tag: # filters by tag, e.g. rate-limiting, etc. it only supports one, omit it for all tags
  - product: # filters by product, it only supports one , omit for all products

we can update to also support: tool: # filter by tool, omit for all tools

We could also make them accept more than one value, but we should use the plural for the key then

Copy link
Collaborator

Choose a reason for hiding this comment

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

I ended up implementing the changes I mentioned above ^

Comment on lines +61 to +65
- "**Admin API:** Allows you to configure and manage Kong Gateway entities."
- "**Konnect API:** Allows you to configure and manage Konnect-specific components, like Dev Portal or API Products."
- "**decK:** Allows you to visualize configurations and apply changes in a declarative manner to Kong Gateway or Konnect."
- "**Terraform:** Allows you to manage infrastructure as code and automated deployments to streamline setup and configuration of Konnect and Kong Gateway."
- "**KIC:** Allows you to manage ingress traffic and routing rules."
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we talked about not including lists like this (entity landing page was the example?), since all of this information should be on the cards themselves.

Comment on lines +26 to +29
text: Rate limiting controls the number of API requests a client can make within a specified time frame.
It's a critical function that helps maintain
the performance and availability of web
services and APIs by controlling the request traffic.
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
text: Rate limiting controls the number of API requests a client can make within a specified time frame.
It's a critical function that helps maintain
the performance and availability of web
services and APIs by controlling the request traffic.
text: There are three types of tools availble for interacting with Kong Gateway
APIs: The Admin API and the control plane configuration API.
SDKs:
CLIs: CLI utilities like decK are available for configuring KGW and Konnect

Really rough idea of a way we could split this into being about the three tool types if we decide to go that route. Then we can split the cards at the bottom by those types.

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.

6 participants