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

Plugin dev quickstart #7068

Merged
merged 43 commits into from
May 2, 2024
Merged

Plugin dev quickstart #7068

merged 43 commits into from
May 2, 2024

Conversation

rspurgeon
Copy link
Contributor

@rspurgeon rspurgeon commented Mar 12, 2024

Adds a plugin developer getting started guide that walks users through building a custom Lua plugin from the beginning.

Description

Adds a new step-by-step quickstart page, helping developers build custom plugins quickly.

https://deploy-preview-7068--kongdocs.netlify.app/gateway/unreleased/plugin-development/get-started/index/

@rspurgeon rspurgeon added the review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly? label Mar 12, 2024
Copy link

netlify bot commented Mar 12, 2024

Deploy Preview for kongdocs ready!

Name Link
🔨 Latest commit f8baef0
🔍 Latest deploy log https://app.netlify.com/sites/kongdocs/deploys/66337ca04fb0d900089a98b0
😎 Deploy Preview https://deploy-preview-7068--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: 94 (🟢 up 2 from production)
Accessibility: 93 (no change from production)
Best Practices: 98 (🟢 up 8 from production)
SEO: 91 (🟢 up 1 from production)
PWA: -
View the detailed breakdown and full score reports

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

@rspurgeon rspurgeon marked this pull request as ready for review March 18, 2024 15:02
@rspurgeon rspurgeon requested a review from a team as a code owner March 18, 2024 15:02
@rspurgeon rspurgeon force-pushed the plugin-dev-quickstart branch 2 times, most recently from 2ebb07f to 91898a9 Compare April 5, 2024 15:23
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.

Partial review, just got through the testing topic. Mostly copyedits for now, haven't run into any real issues.

app/_data/docs_nav_gateway_3.7.x.yml Outdated Show resolved Hide resolved
app/_src/gateway/plugin-development/get-started/setup.md Outdated Show resolved Hide resolved
app/_src/gateway/plugin-development/get-started/setup.md Outdated Show resolved Hide resolved
app/_src/gateway/plugin-development/get-started/setup.md Outdated Show resolved Hide resolved
app/_src/gateway/plugin-development/get-started/setup.md Outdated Show resolved Hide resolved
app/_src/gateway/plugin-development/get-started/testing.md Outdated Show resolved Hide resolved
app/_src/gateway/plugin-development/get-started/testing.md Outdated Show resolved Hide resolved
Comment on lines 323 to 324
Pongo will determine if dependency containers are already running and use them
if so. The test library will handle truncating existing data in between test runs for us.
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
Pongo will determine if dependency containers are already running and use them
if so. The test library will handle truncating existing data in between test runs for us.
Pongo determines if dependency containers are already running and use them if they are.
The test library handles truncating existing data in between test runs.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@lena-larionova I reworked this but did not take the suggestion.

app/_src/gateway/plugin-development/get-started/testing.md Outdated Show resolved Hide resolved
app/_src/gateway/plugin-development/get-started/testing.md Outdated Show resolved Hide resolved
Copy link
Member

@mheap mheap left a comment

Choose a reason for hiding this comment

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

This is looking awesome 🙌

app/_src/gateway/plugin-development/get-started/testing.md Outdated Show resolved Hide resolved
app/_src/gateway/plugin-development/get-started/http.md Outdated Show resolved Hide resolved
app/_src/gateway/plugin-development/get-started/http.md Outdated Show resolved Hide resolved
app/_src/gateway/plugin-development/get-started/http.md Outdated Show resolved Hide resolved
app/_src/gateway/plugin-development/get-started/deploy.md Outdated Show resolved Hide resolved
app/_src/gateway/plugin-development/get-started/deploy.md Outdated Show resolved Hide resolved
app/_src/gateway/plugin-development/get-started/deploy.md Outdated Show resolved Hide resolved
@rspurgeon
Copy link
Contributor Author

@lena-larionova @mheap @outsinre @cloudjumpercat I'm looking for final approval on this PR. Thanks in advance.

@mheap mheap self-requested a review May 2, 2024 12:00
@mheap mheap merged commit a83e11e into main May 2, 2024
15 checks passed
@mheap mheap deleted the plugin-dev-quickstart branch May 2, 2024 12:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly?
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants