From 714f9df3cfb8750d875697df2808dee54b321808 Mon Sep 17 00:00:00 2001 From: Jonas Kello <jonaskello@users.noreply.github.com> Date: Fri, 1 Jan 2021 13:53:35 +0100 Subject: [PATCH] Link docs how to get zsh completion to work in getting-started I tried to make completions work in zsh by just adding the same code as for the bash example but of course switching bash for zsh but it did not work. When I googled and dug deeper I finally found the answer in the deeper docs here: https://github.com/fluxcd/flux2/blob/main/docs/cmd/flux_completion_zsh.md The command in there works if I add it to my .zshrc file. I think linking to these specific docs may prevent others from just assuming it will work the same in zsh. Signed-off-by: Jonas Kello <jonas.kello@gmail.com> --- docs/get-started/index.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/get-started/index.md b/docs/get-started/index.md index ef3c1a58..e9fe2598 100644 --- a/docs/get-started/index.md +++ b/docs/get-started/index.md @@ -42,15 +42,14 @@ binary). Binaries for **macOS**, **Windows** and **Linux** AMD64/ARM are available for download on the [release page](https://github.com/fluxcd/flux2/releases). -To configure your shell to load `flux` completions add to your Bash -profile: +To configure your shell to load `flux` [bash completions](../cmd/flux_completion_bash.md) add to your profile: ```sh # ~/.bashrc or ~/.bash_profile . <(flux completion bash) ``` -`zsh`, `fish`, and `powershell` are also supported with their own sub-commands. +[`zsh`](../cmd/flux_completion_zsh.md), [`fish`](../cmd/flux_completion_fish.md), and [`powershell`](../cmd/flux_completion_powershell.md) are also supported with their own sub-commands. ## GitOps workflow -- GitLab