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

Feat: Plugin examples #7327

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

Feat: Plugin examples #7327

wants to merge 8 commits into from

Conversation

lena-larionova
Copy link
Contributor

@lena-larionova lena-larionova commented May 1, 2024

Description

Add hub examples directory with some existing examples for openId connect, HTTP Log, and AI Proxy (three plugins that I knew had useable examples).

https://konghq.atlassian.net/browse/DOCU-3835

Notes:

  • I put them into app/assets/hub/kong-inc to mimic the pattern that KIC and KGO use for their examples. Does that work?
  • Added a "description" field to explain what the config is doing.
    • Included prereqs that are as short as possible
    • Included values that the user needs to customize

@fabianrbz For the prereqs and customizable values, is it fine to just have them manually written in the description? Or would it be better to do something like this, in case the various bits have to get pulled into a layout separately:

description: |
  Configure the plugin to do a thing.
prerequisites: |
  Do this thing first.
custom_values:
  - client_id
  - client_secret
  - redirect_uri
config:
  ...

Maybe that's a question for Carl & whoever implements the frontend eventually.

Testing instructions

Preview link:

Checklist

@lena-larionova lena-larionova added the review:tech Request for technical review on the docs platform or processes. label May 1, 2024
Copy link

netlify bot commented May 1, 2024

Deploy Preview for kongdocs ready!

Name Link
🔨 Latest commit a47bbbe
🔍 Latest deploy log https://app.netlify.com/sites/kongdocs/deploys/665a30042ab985000817d272
😎 Deploy Preview https://deploy-preview-7327--kongdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
9 paths audited
Performance: 95 (🟢 up 3 from production)
Accessibility: 93 (no change from production)
Best Practices: 98 (🟢 up 8 from production)
SEO: 91 (no change from production)
PWA: -
View the detailed breakdown and full score reports

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

@mheap
Copy link
Member

mheap commented May 2, 2024

Can we keep custom_values in a separate list? We can generate templated output from that and it makes the data useful for the UI e.g. a "move to next field" button to cycle through required fields

@lena-larionova
Copy link
Contributor Author

Can we keep custom_values in a separate list? We can generate templated output from that and it makes the data useful for the UI e.g. a "move to next field" button to cycle through required fields

That makes sense to me.

What about prereqs?

@fabianrbz
Copy link
Contributor

I would keep pre_reqs in a separate list too, it gives us more flexibility

@lena-larionova
Copy link
Contributor Author

@fabianrbz done. Kept the label short as prereqs because prerequisites is prone to spelling errors 😄

@@ -0,0 +1,9 @@
description: |
Maximum of 100 requests every rolling hour, continuously adjusting the count over the course of the hour. No hard limit or known reset.
Copy link
Member

Choose a reason for hiding this comment

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

Do we have a concrete example to help understand what this means? e.g.

  1. Consumer sends X requests in Y minutes
  2. Something happend
  3. Y minutes pass, something resets
  4. Consumer can make more requests

@lena-larionova lena-larionova marked this pull request as ready for review May 23, 2024 17:00
@lena-larionova lena-larionova requested a review from a team as a code owner May 23, 2024 17:00
@lena-larionova lena-larionova requested a review from mheap June 4, 2024 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review:tech Request for technical review on the docs platform or processes.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants