[Feature Request] Please differentiate shell environment variables from temporal env environment variables in docs
Open
Beginner friendly
Nobody has claimed this yet.
enhancement
- Dominant language
- Go
- Stars
- 379
- Forks
- 103
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 23
Description
Is your feature request related to a problem? Please describe.
The list of environment variables on https://docs.temporal.io/cli#environment-variables does not explicitly state that these are environment variables set with your shell and not temporal env.
Describe the solution you'd like
Suggested fix:
:::tip ENVIRONMENT VARIABLES
Do not confuse environment variables, set with your shell, with temporal env options.
:::
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the environment variables section at https://docs.temporal.io/cli#environment-variables and review how it describes the variables. Add a tip clarifying that these are shell-set environment variables, distinct from temporal env options, then verify the rendered documentation clearly communicates the distinction.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- shell
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 70/100