Complete documentation on CLI configuration file
Open
Nobody has claimed this yet.
kind/docs
- Dominant language
- Go
- Stars
- 6.1k
- Forks
- 2.2k
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 43
Description
Some new elements are missing in the Configuration files Documentation. Most of them were present in the config file but labeled as experimental.
-
orchestrator(swarm|kubernetes|all) -
kubernetes/allNamespaces: Disable all namespaces default behaviour (see #1059 )
Also some online documentation should be updated:
- Add a section on
Working with multiple orchestrators
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
Start in docs/reference/commandline/cli.md at the Configuration files section and review the related behavior described in #1059. Document the orchestrator and kubernetes/allNamespaces settings, then add the Working with multiple orchestrators section. Done means all three checklist items are covered in the online documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100