Skip to content

chore(kongctl): install with the Homebrew formula - #7072

Open
rspurgeon wants to merge 2 commits into
mainfrom
task/kongctl-homebrew-formula-docs
Open

chore(kongctl): install with the Homebrew formula#7072
rspurgeon wants to merge 2 commits into
mainfrom
task/kongctl-homebrew-formula-docs

Conversation

@rspurgeon

@rspurgeon rspurgeon commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Description

Recommend brew install --formula kong/kongctl/kongctl as the Homebrew
installation command in the kongctl macOS installation tab and homepage CLI
card. Keep introductory installation instructions focused on the formula.

Add cask-to-formula migration instructions to the existing kongctl
troubleshooting page, including uninstalling the cask first and verifying the
new installation. Configuration and stored credentials are preserved.

This documentation change does not deprecate the cask or change its support.
Any cask retirement schedule will be handled separately.

Related to Kong/kongctl#2009 and Kong/kongctl#2087. The formula installation
has already been manually verified on macOS; a new release is not required
to publish these installation instructions.

Preview Links

  • /kongctl/?tab=macos#install-kongctl
  • / (kongctl CLI card)
  • /kongctl/troubleshooting/#switch-from-the-cask-to-the-formula

Validation

  • Vale: zero errors, warnings, or suggestions in both changed Markdown files.
  • Homepage YAML and troubleshooting frontmatter parse successfully.
  • git diff --check: passed.
  • Formula installation and cask-to-formula migration were manually verified
    on macOS during the Homebrew rollout.
  • Full site build and Ruby tests were not run locally: required gems are
    missing (bundle check). CI validation remains required.

Checklist

  • Installation and migration commands were manually tested on macOS.
  • Existing page metadata is preserved; no new pages were added.
  • No new documentation links or autogenerated instructions were added.
  • Style checks pass.
  • No product index changes are required.

@rspurgeon
rspurgeon marked this pull request as ready for review September 1, 2026 15:41
@rspurgeon
rspurgeon requested a review from a team as a code owner September 1, 2026 15:41
@netlify

netlify Bot commented Sep 1, 2026

Copy link
Copy Markdown

Deploy Preview for kongdeveloper ready!

Name Link
🔨 Latest commit 29c3ed5
🔍 Latest deploy log https://app.netlify.com/projects/kongdeveloper/deploys/6a9cdcabe1e95800080fb1af
😎 Deploy Preview https://deploy-preview-7072--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 1, 2026 16:10
@rspurgeon rspurgeon added the do not merge Issues/ PRs whose changes should not be merged at this time label Sep 3, 2026
@rspurgeon

Copy link
Copy Markdown
Contributor Author

Do not merge, pending investigation into apple code signing and other installation options. Leaving open for now if docs team is ok w/ the draft PR. If not it's fine to close until time to guide users with this

@rspurgeon
rspurgeon marked this pull request as ready for review September 6, 2026 03:23
@rspurgeon
rspurgeon force-pushed the task/kongctl-homebrew-formula-docs branch from e26ffb2 to 29c3ed5 Compare September 6, 2026 03:23
@rspurgeon rspurgeon removed the do not merge Issues/ PRs whose changes should not be merged at this time label Sep 6, 2026
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