doc: de-duplicate instructions in kind and hubble getting started guides #12210
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
rolinh
added
area/documentation
michi-covalent
approved these changes
Jun 19, 2020
joestringer
requested changes
Jun 19, 2020
There was a problem hiding this comment.
Looks good, thanks for tidying this up.
A made some minor suggestions below to use imperative sense to simplify the language on the steps necessary to install Helm. (I realise they're not all from this PR, but I think that they clarify the wording).
I also made some suggestions on the use of sphinx directives for syntax highlighting, things like .. parsed-literal usage when literals are not passed.
rolinh
force-pushed
the
pr/rolinh/doc-kind-hubble-gsg-dedup
branch
from
ad67f34
to
1b564fc
Compare
joestringer
approved these changes
Jun 19, 2020
These 2 guides have a lot of instructions in common as the Hubble guide instructs to create a sandbox environment using Kind. This commit ensures that instructions are not duplicated in the two guides but are included from separate files from the 2 guides. In addition to this, this commit also updates the instructions about possible conflict of IP address when deploying a cluster with Kind: the "tip" has been moved to the "Configure Kind" section as the fix needs to be applied when configuring Kind. Moreover, remove the "Optional" wording with regard to pre-loading the cilium image into the Kind cluster. Signed-off-by: Robin Hahling <robin.hahling@gw-computing.net>
rolinh
force-pushed
the
pr/rolinh/doc-kind-hubble-gsg-dedup
branch
from
1b564fc
to
f4d7847
Compare
maintainer-s-little-helper
bot
moved this from Needs backport from master
to Backport pending to v1.8
in 1.8.0
maintainer-s-little-helper
bot
moved this from Needs backport from master
to Backport pending to v1.8
in 1.8.0
maintainer-s-little-helper
bot
moved this from Backport pending to v1.8
to Backport done to v1.8
in 1.8.0
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.
These 2 guides have a lot of instructions in common as the Hubble guide
instructs to create a sandbox environment using Kind. This commit
ensures that instructions are not duplicated in the two guides but are
included from separate files from the 2 guides.
In addition to this, this commit also updates the instructions about
possible conflict of IP address when deploying a cluster with Kind: the
"tip" has been moved to the "Configure Kind" section as the fix needs to
be applied when configuring Kind.
Moreover, remove the "Optional" wording with regard to pre-loading the
cilium image into the Kind cluster.