Skip to content

task(docs): document Konnect APIOps with kongctl and GitHub Actions - #7230

Open
rspurgeon wants to merge 4 commits into
mainfrom
cicd-docs-expansion
Open

rspurgeon wants to merge 4 commits into
mainfrom
cicd-docs-expansion

Conversation

@rspurgeon

@rspurgeon rspurgeon commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

Description

Document APIOps for Konnect with kongctl and GitHub Actions: store declarative configuration in GitHub, show diffs on pull requests, and apply changes on pushes to main.

The quickstart uses just two files: one manifest with a Dev Portal, API, inline OpenAPI specification, and publication; and one GitHub Actions workflow. Only a Konnect access token is required. Add the guide to the CI/CD index section and link it from the landing and agent-skills pages.

Companion repository guidance: Kong/kongctl#2178. Publish this page before merging that PR's links.

Preview Links

Validation

  • Targeted Jekyll build passed; rendered manifest and workflow match source, including GitHub expressions.
  • Frontmatter validation, both Vale passes (including CI frontmatter preprocessing), actionlint/ShellCheck, and whitespace checks passed.
  • kongctl 1.15.1 against a local HTTPS API stub successfully planned and applied the portal, API, version with inline spec, and publication.
  • No live Konnect deployment or hosted run of the example workflow was performed.

Checklist

  • Tested how-to docs locally; live deployment remains untested as noted above.
  • All pages contain metadata.
  • New docs link to existing docs.
  • Configuration and workflow instructions render correctly.
  • Style guide implemented correctly.
  • Every page has a description entry in frontmatter.
  • Added the new page to the product documentation index.

@rspurgeon
rspurgeon requested a review from a team as a code owner September 14, 2026 17:15
@netlify

netlify Bot commented Sep 14, 2026

Copy link
Copy Markdown

Deploy Preview for kongdeveloper ready!

Name Link
🔨 Latest commit f4034e8
🔍 Latest deploy log https://app.netlify.com/projects/kongdeveloper/deploys/6aa97f3c88942000086a961b
😎 Deploy Preview https://deploy-preview-7230--kongdeveloper.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

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

@rspurgeon
rspurgeon marked this pull request as draft September 14, 2026 17:52
@rspurgeon rspurgeon changed the title task(docs): add kongctl GitHub Actions quickstart task(docs): document Konnect APIOps with kongctl and GitHub Actions Sep 14, 2026
@rspurgeon
rspurgeon marked this pull request as ready for review September 15, 2026 17:22
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.

1 participant