zsh type completion install docs don't account for homebrew destinations

Open Beginner friendly
#445 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
zsh
Domain
documentation

Research direction

Open the README section “Completion scripts for plain zsh” linked in the issue and review the existing /opt/kubectx destination references. Document the Homebrew destination /opt/homebrew/opt/kubectx/share/zsh/site_functions and any relevant installation-path differences described by the issue. Done means Homebrew users can identify the correct completion path without changing code.

Written by the indexing model from the issue text.

Description

References in the docs for type completion linking for zsh point at /opt/kubectx which doesn't appear for homebrew installation. The type completion is in /opt/homebrew/opt/kubectx/share/zsh/site_functions. If there are variances in where these land, it would perhaps be prudent to expand the docs to indicate the differences.

For reference: https://github.com/ahmetb/kubectx?tab=readme-ov-file#completion-scripts-for-plain-zsh

Dominant language
Go
Stars
20k
Forks
1.4k
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ahmetb/kubectx

All issues in ahmetb/kubectx

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.