Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve Quick Start and Running Locally #11473

Merged
merged 1 commit into from
Jul 29, 2023

Conversation

agilgur5
Copy link
Member

@agilgur5 agilgur5 commented Jul 28, 2023

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

  • 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

    • this is not needed when using the Dev Container, as it is mounted to the correct directory inside the container
  • clarify Docker's embedded k8s - "Docker Desktop with its embedded Kubernetes" -> "Docker Desktop's embedded Kubernetes"

    • Docker Desktop itself isn't the problem, it's the k8s feature specifically.
    • this is a follow-up to another clarification from a previous change. hopefully this is the last clarification 😅
  • 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)

    • "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

Verification

n/a

- 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>
@terrytangyuan terrytangyuan merged commit 0118429 into argoproj:master Jul 29, 2023
26 checks passed
@agilgur5 agilgur5 deleted the docs-run-local-improve branch July 29, 2023 03:04
@agilgur5 agilgur5 added area/docs Incorrect, missing, or mistakes in docs area/build Build or GithubAction/CI issues labels Sep 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/build Build or GithubAction/CI issues area/docs Incorrect, missing, or mistakes in docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants