docs: full copy-edit of environment-variables.md
#12148
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
environment-variables.md
had some inconsistencies and mistakes in it.Modifications
Accuracy fixes
GRPC_MESSAGE_SIZE
was used in the example yet wasn't in the Server's env var listConsistency
consistently use 1 sentence per line
consistently use "Server and Controller" instead of
argo-server
andworkflow-controller
(or the lowercase variants)consistently use the sentence "You can set environment variables [...] like the following"
Misc
be more direct with the first line description of the document, per k8s style guide
use
!!! Warning
block instead of a unicode characterlink to the
workflow-controller-configmap
when it is mentionedworkflow-controller-configmap
Verification
make docs
andmake codegen
pass