docs: remove incorrect statement about DIND not working #13781
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- as users have mentioned, it does still work and the image used was one that comes with Docker Engine and so does not rely on the k8s container engine - replace with a note about "Alternatives", since DIND is still not as secure - use a proper admonition for the note as well, instead of "Note:" with a horizontal rule after - also follow docs style guide for the rest of the page while at it - prefer 1 sentence per line, per [style guide](https://argo-workflows.readthedocs.io/en/release-3.5/doc-changes/) - use active voice, per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#use-active-voice) - simple and direct, per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#use-simple-and-direct-language) - consistently address the user as "you" (instead of using both "you" and "we"), per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#address-the-reader-as-you) Signed-off-by: Anton Gilgur <[email protected]>
agilgur5
force-pushed
the
docs-remove-incorrect-dind-note
branch
from
c99886b to
c68e67a
Compare
|
Thanks for doing this. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #13010 (comment), #10778 (comment)
Motivation
As users have mentioned, DIND does still work and the specific DIND image used comes with Docker Engine and so does not rely on the k8s container engine
Modifications
replace the
dockershimnote with one about "Alternatives", since DIND is still not as securealso follow docs style guide for the rest of the page while at it
raw.githubas GH is much nicer to read (e.g. syntax highlighting, line numbers, etc etc) and won't auto-download a file on certain browsers (both especially for mobile)add a link to the sidecar docs when it is mentioned as well
Verification
make docspasses