Skip to content

docs: modernize the Konnect Reference Platform - #6981

Open
rspurgeon wants to merge 23 commits into
mainfrom
reference-platform
Open

rspurgeon wants to merge 23 commits into
mainfrom
reference-platform

Conversation

@rspurgeon

@rspurgeon rspurgeon commented Aug 26, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • reframes the Konnect Reference Platform as maintained architecture guidance plus a readable working example, not a bootstrap tool
  • removes koctl, Konnect Orchestrator, registry, polling, and fictional reference-platform command guidance
  • documents federated platform and service ownership with one default branch and distinct development and production resources
  • documents a beta-root and immutable-stable OpenAPI lifecycle with PR-producing release automation
  • materializes deterministic decK state into service PRs so reviewers approve the exact Gateway configuration
  • documents ownership-scoped kongctl sync, exact-artifact production promotion, and RBAC boundaries
  • uses Key Auth plus platform-owned global ACE for protected APIs and leaves public APIs anonymous
  • redirects the removed Orchestrator page and links the optional AI Marketplace skill

Working example PRs

kongctl compatibility

The example workflows intentionally install the latest stable kongctl release by omitting the kongctl-version input from the SHA-pinned Kong/setup-kongctl action. The examples preserve generalized external lookup as the federated target and serve as a live compatibility test bed; they do not introduce a compatibility registry or wrapper.

Validation

  • Vale on all changed Markdown: zero findings
  • frontmatter validation and git diff check
  • deterministic decK 1.65.2 generation and validation in all four service repositories
  • actionlint for all service workflows
  • ownership and release lint for all four services
  • service follow-up PR validation is green

CI remains the full-site proof.

@rspurgeon
rspurgeon requested a review from a team as a code owner August 26, 2026 23:07
@netlify

netlify Bot commented Aug 26, 2026 •

Copy link
Copy Markdown

❌ Deploy Preview for kongdeveloper failed.

Name Link
🔨 Latest commit 79acfb1
🔍 Latest deploy log https://app.netlify.com/projects/kongdeveloper/deploys/6ad2e0ad506c3c102f16b487

@rspurgeon

Copy link
Copy Markdown
Contributor Author

Currently the broken link is expected due to pending merges in the example repository this documentation refers to. Once the example repositories are merged, this link will resolve properly.

@rspurgeon
rspurgeon marked this pull request as ready for review October 15, 2026 16:32
@kong-ksai

kong-ksai Bot commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

✅ KSAI Review: Finished


Run report (federated) · 1 paid run · $0.2337 total
# Engine Result Model Turns Cost
1 opencode success deepseek-ai/deepseek-v4.1-flash/max 45 $0.2337

Reviewing cost $0.2337

@kong-ksai kong-ksai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Check Result
Scope Docs-only reframe of the Konnect Reference Platform: how-to, landing page, APIOps, FAQ and KongAirlines pages, index, redirects, and removal of the Orchestrator page.
Mandate default-code-reviewer
Findings 2 Low
Findings audit Independent audit completed: corrected one citation in the ACE link finding; both Low findings upheld.

The rewrite is coherent and the removals are complete: no changed page cites koctl or the Orchestrator, and the how-to keeps its closing validation step.

No additional concerns found: the diff adds no secrets, no credential handling, and no executable code. The head's build check fails, and its bounded log shows runner setup only, so CI is unconfirmed.

Comment thread app/konnect-reference-platform/apiops.md Outdated
Comment thread app/_how-tos/konnect-platform/konnect-reference-platform.md Outdated
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