flyteorg / flyteorg/flyte

[Docs] Add jq installation note for Windows (WSL) users using curl command

Open
#6,398 5 comments 0 reactions 1 assignee Claimed by @0yukali0 View on GitHub
documentation untriaged
Dominant language
Go
Stars
7.5k
Forks
886
Avg merge
1d 12h
Merged PRs (30d)
120

Description

### Description

While going through the [flytectl installation instructions](https://www.union.ai/docs/flyte/user-guide/getting-started/local-setup/), I noticed that the curl usage instructions on Linux mention that jq needs to be installed to run the script:
`To use curl, set BINDIR to the installation location (it defaults to ./bin) and run the following command (note that [jq](https://jqlang.org/) needs to be installed to run this script):`

However, the corresponding Windows instructions (which use a Linux shell like WSL) do not include this note.
`To use curl, in a Linux shell (such as [WSL](https://learn.microsoft.com/en-us/windows/wsl/install)), set BINDIR to the install location (it defaults to ./bin) and run the following command:`

This small addition could help improve the installation experience for Windows users — especially beginners like myself who are still getting used to WSL.

### Are you sure this issue hasn't been raised already?

- [x] Yes

### Have you read the Code of Conduct?

- [x] Yes

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.