update(kongctl): Add missing docs, update, and copyedit#5240
Open
lena-larionova wants to merge 6 commits into
Open
update(kongctl): Add missing docs, update, and copyedit#5240lena-larionova wants to merge 6 commits into
lena-larionova wants to merge 6 commits into
Conversation
✅ Deploy Preview for kongdeveloper ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR prepares the kongctl documentation set for GA by adding missing reference pages and substantially expanding the declarative and troubleshooting guidance across the /app/kongctl/ docs.
Changes:
- Added new reference pages for audit log listening and for supported declarative resource schemas.
- Expanded the kongctl troubleshooting guide with common errors, debugging workflows, and quick-reference tables.
- Updated and copyedited existing kongctl reference docs (declarative, authentication, config, kongctl+decK integration).
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| app/kongctl/troubleshooting.md | Adds extensive troubleshooting scenarios, debugging steps, and reference tables. |
| app/kongctl/supported-resources.md | Introduces a consolidated reference for supported declarative resource types and fields. |
| app/kongctl/kongctl-and-deck.md | Minor copyedits to improve clarity/consistency around decK integration behavior. |
| app/kongctl/declarative.md | Adds missing declarative workflow details (modes, scoping rules, env tags, best practices). |
| app/kongctl/config.md | Cleans up related links and fixes a command typo in examples. |
| app/kongctl/authentication.md | Copyedits for clarity and consistency (including naming and grammar fixes). |
| app/kongctl/audit-logs.md | Adds new reference documentation for the audit-log listener, tailing, and detached mode. |
Comments suppressed due to low confidence (1)
app/kongctl/supported-resources.md:187
- The
application_auth_strategiesYAML example is missing the usual indentation before the list item (- ref: ...), and several following schema blocks use the same pattern; please indent list items consistently so the examples remain valid YAML.
```yaml
application_auth_strategies:
- ref: string
name: string required
display_name: string required
|
|
||
| 1. Validate YAML syntax: | ||
| ```bash | ||
| cat config.yaml | python -m yaml |
lena-larionova
commented
May 15, 2026
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
lena-larionova
force-pushed
the
chore/update-kongctl-docs
branch
from
7af166f to
f70bb8a
Compare
lena-larionova
force-pushed
the
chore/update-kongctl-docs
branch
from
edd17ae to
f70bb8a
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Prepping for kongctl GA.
Adding:
Copyediting all the things.
Preview Links
https://deploy-preview-5240--kongdeveloper.netlify.app/index/kongctl/declarative
https://deploy-preview-5240--kongdeveloper.netlify.app/index/kongctl/supported-resources
https://deploy-preview-5240--kongdeveloper.netlify.app/index/kongctl/troubleshooting
https://deploy-preview-5240--kongdeveloper.netlify.app/index/kongctl/audit-logs