docs: improve Quick Start and Running Locally #11473
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
I noticed that Running Locally could use various improvements (grammar, style, links, formatting, etc) when I first read it (it was confusing, to say the least), and after reviewing #11405 I was reminded of this again. So went through the whole first half and made modifications
Modifications
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
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
argo-workflows
consistently when describing the folder name (which is by default the name of the repo)use "local machine" consistently
use "VSCode" or "Visual Studio Code" consistently, which are common community terms (not, for example, "Visual Studio", which is the name of a different IDE and which people often need to clarify)
move "Git Clone" section into Requirements
clarify Docker's embedded k8s - "Docker Desktop with its embedded Kubernetes" -> "Docker Desktop's embedded Kubernetes"
remove copy+pasted descriptions of what a Dev Container is
use present tense where possible / appropriate (https://kubernetes.io/docs/contribute/style/style-guide/#use-present-tense)
use more direct language where possible (https://kubernetes.io/docs/contribute/style/style-guide/#use-simple-and-direct-language)
fix miscellaneous grammar
Verification
n/a