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: full copy-edit of environment-variables.md #12148

Merged
merged 3 commits into from
Nov 14, 2023

Conversation

agilgur5
Copy link

@agilgur5 agilgur5 commented Nov 4, 2023

Motivation

environment-variables.md had some inconsistencies and mistakes in it.

  • I've linked to it a few times and have added relative links from other places in the docs, so would like to make sure the page is accurate etc

Modifications

Accuracy fixes

  • move Server env vars and examples into the Server section
    • instead of being in the Controller block
    • GRPC_MESSAGE_SIZE was used in the example yet wasn't in the Server's env var list
      • it was incorrectly in the Controller list, confirmed it was only used in Server code
      • also add its previously missing default into the table
    • also comment out ellipses in code block so that the block is all valid code

Consistency

  • consistently use 1 sentence per line

  • consistently use "Server and Controller" instead of argo-server and workflow-controller (or the lowercase variants)

    • consistent with the rest of this page and the rest of the docs
    • those names are primarily referenced in the manifests
  • consistently use the sentence "You can set environment variables [...] like the following"

    • there were a few variations on this before
    • consistently use "Deployment's container spec"
      • similarly a few variations before

Misc

  • be more direct with the first line description of the document, per k8s style guide

  • use !!! Warning block instead of a unicode character

    • this is more consistent with the rest of the docs and a more clear warning
  • link to the workflow-controller-configmap when it is mentioned

    • keep references to it consistent across the docs; always use workflow-controller-configmap

Verification

make docs and make codegen pass

Anton Gilgur added 3 commits November 4, 2023 18:31
- consistently use "Server and Controller" instead of `argo-server` and `workflow-controller` (or the lowercase variants)
  - consistent with the rest of this page and the rest of the docs
  - those names are primarily referenced in the manifests

- consistently use the sentence "You can set environment variables [...] like the following"
  - there were a few variations on this before
  - consistently use "Deployment's container spec"
    - similarly a few variations before

- link to the `workflow-controller-configmap` when it is mentioned
  - keep references to it consistent across the docs; always use `workflow-controller-configmap`

- comment out ellipses in code block so that the block is all valid code

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
- instead of being in the Controller block
- `GRPC_MESSAGE_SIZE` was used in the example yet wasn't in the Server's env var list
  - it was incorrectly in the Controller list, confirmed it was only used [in Server code](https://github.com/argoproj/argo-workflows/blob/a47e46208cd0029ef2e35019207d0b1ee4f85ea4/server/apiserver/argoserver.go#L119)
  - also add its default into the table

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
- use `!!! Warning` block instead of a unicode character
  - this is more consistent with the rest of the docs and a more clear warning

- be more direct with the description of the document, per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#use-simple-and-direct-language)

- consistently use 1 sentence per line

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
@agilgur5 agilgur5 added the area/docs Incorrect, missing, or mistakes in docs label Nov 4, 2023
@juliev0 juliev0 merged commit 18c5925 into argoproj:master Nov 14, 2023
16 checks passed
@agilgur5 agilgur5 deleted the docs-env-vars-copy-edit branch November 14, 2023 23:43
shuangkun pushed a commit to shuangkun/argo-workflows that referenced this pull request Nov 21, 2023
Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Incorrect, missing, or mistakes in docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants