Suggested updates to the sample network readme #19
Conversation
This file contains hidden or 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
jt-nti
approved these changes
Jun 24, 2022
| @@ -12,20 +12,34 @@ Feedback, comments, questions, etc. at Discord : [#fabric-kubernetes](https://di | |||
|
|
|||
|  | |||
|
|
|||
| ## Prerequisites: | |||
| ## Essential Setup | |||
There was a problem hiding this comment.
I like the term "essential setup"!
jkneubuh
suggested changes
Jun 24, 2022
There was a problem hiding this comment.
These are nice updates. I like the addition of just to just streamline the setup. Two minor requests:
-
just kindseems nice, butjust networkorjust sample-networkorjust everythingseems more appropriate. Can we do this justice with perhaps just two just commands? (One for kind : set up kind and init the cluster, and a second target to bring up the network on some k8s?) -
The essential setup list is seeming "too long." Can we put the k9s and just sections into another section for optional / recommended software? Something like :
Essential Setup :
- x
- y
- z
Fabric bin PATH stuff here
Optional Setup:
- k9s
- just
Kubernetes
...
?
mbwhite
force-pushed
the
sample-network-docs-updates
branch
2 times, most recently
from
e415203 to
0bca544
Compare
|
@jkneubuh I've updated the readme as per your suggestions... |
Therese are some suggested updates to make the overall 'flow' of the readme.md better. So it easier for Fred/Fiona to follow along. Also added a way of 'cheating' if you been through the tutorial before, then just a quick recap of the commands is useful Signed-off-by: mbw <[email protected]>
mbwhite
force-pushed
the
sample-network-docs-updates
branch
from
0bca544 to
5ff6654
Compare
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.
Therese are some suggested updates to make the overall 'flow' of the
readme.md better. So it easier for Fred/Fiona to follow along.
Also added a way of 'cheating' if you been through the tutorial before, then just a quick recap
of the commands is useful
Signed-off-by: mbw [email protected]