Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: improve Quick Start and Running Locally
- use a warning box for nicer looking formatting than unicode - clarify that dev container does not necessarily need VSCode given that there is a CLI - it said this before, but the ordering of the wording made it confusing and easy to miss - also use code backticks for `devcontainer` CLI as that is the name of the command (see k8s style guide: https://kubernetes.io/docs/contribute/style/style-guide/#code-style-inline-code) - use "Dev Container" as the proper noun when referring to the tool in general (not specific to CLI) - use `argo-workflows` consistently when describing the folder name (which is by default the name of the repo) - move "Git Clone" section into Requirements - this is not needed when using the Dev Container, as it is mounted to the correct directory inside the container - remove copy+pasted descriptions of what a Dev Container is - Dev Container docs say this verbatim: https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers. leave that to their docs to describe it if people are unfamiliar with the tool - use present tense where possible / appropriate (https://kubernetes.io/docs/contribute/style/style-guide/#use-present-tense) - "will run" -> "runs" - "you'll have" -> "you have" - use more direct language where possible (https://kubernetes.io/docs/contribute/style/style-guide/#use-simple-and-direct-language) - "a cluster to use to test against" -> "a cluster to test against" - fix miscellaneous grammar - run-on sentences, missing commas, extra commas, etc Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
- Loading branch information