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

Inigo plugin initial docs #7785

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

Inigo plugin initial docs #7785

wants to merge 3 commits into from

Conversation

ejoffe
Copy link

@ejoffe ejoffe commented Aug 23, 2024

Description

This PR adds the docs for Inigo Kong Plugin

Testing instructions

Preview link:

Checklist

  • Review label added
  • [Conditional version tags]

@ejoffe ejoffe requested a review from a team as a code owner August 23, 2024 04:01
Copy link

netlify bot commented Aug 23, 2024

Deploy Preview for kongdocs ready!

Name Link
🔨 Latest commit de5dd9a
🔍 Latest deploy log https://app.netlify.com/sites/kongdocs/deploys/66cd0b43e071f600085ee9d4
😎 Deploy Preview https://deploy-preview-7785--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: 91 (🟢 up 2 from production)
Accessibility: 92 (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.

@lena-larionova lena-larionova self-assigned this Aug 26, 2024
@lena-larionova lena-larionova added the review:copyedit Request for writer review. label Aug 26, 2024
@lena-larionova
Copy link
Contributor

Can you please add "Inigo" to the dictionary file here: https://github.com/inigolabs/docs.konghq.com/blob/main/.github/styles/kong/dictionary.txt

That'll prevent the name from being flagged as a spelling error.

Copy link
Contributor

@lena-larionova lena-larionova left a comment

Choose a reason for hiding this comment

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

Minor phrasing and formatting adjustments

app/_hub/inigo/inigo/overview/_index.md Outdated Show resolved Hide resolved
app/_hub/inigo/inigo/overview/_index.md Outdated Show resolved Hide resolved
app/_hub/inigo/inigo/overview/_index.md Outdated Show resolved Hide resolved
app/_hub/inigo/inigo/overview/_index.md Outdated Show resolved Hide resolved
app/_hub/inigo/inigo/overview/_index.md Outdated Show resolved Hide resolved
app/_hub/inigo/inigo/overview/_index.md Outdated Show resolved Hide resolved
},
{
"config": {
"fields": [
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like the config fields are missing here. Could you please add them, then base the example file off the basic config that the plugin expects?

The example file would be at app/_hub/inigo/inigo/examples/_index.yml.

Copy link
Author

Choose a reason for hiding this comment

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

Our current plugin doesn't have any configuration, I wasn't sure how to represent that?

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm. That's a good question. We haven't had that use case before, so I'm not sure that we've built in support for disabling the config key in the output (here: https://deploy-preview-7785--kongdocs.netlify.app/hub/inigo/inigo/configuration/). Let me look into that.

@lena-larionova
Copy link
Contributor

https://deploy-preview-7785--kongdocs.netlify.app/hub/inigo/inigo/ here's the deploy preview, it works now 😄

@ejoffe
Copy link
Author

ejoffe commented Sep 16, 2024

@lena-larionova : is there anything else that needs to be done from my end?

@lena-larionova
Copy link
Contributor

@ejoffe nothing as of right now. We're waiting for the green light on our end.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review:copyedit Request for writer review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants