-
Notifications
You must be signed in to change notification settings - Fork 2.8k
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: adds a getting started guide for Rancher 2.x #15179
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks Sean, the guide looks nice (although I haven't checked the pictures yet)! But the formatting is not good. You need to address it, Markdown syntax is not valid. See the suggestions inline.
In addition to the use of single backquotes, the CI complains because your document is not included anywhere in the doc, it is an orphan page not linked from any other. You need to reference it, most likely in Documentation/gettingstarted/index.rst
.
Note that you should be able to compile and preview the documentation locally with:
make -C Documentation live-preview
The content looks good, should we also include the instructions to run the connectivity tests, to make sure that Cilium is running as expected?
4ec465f
to
e44338f
Compare
e2ab269
to
11591d7
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Two more observations, one is my fault - Sorry!
Documentation/gettingstarted/k8s-install-rancher-existing-nodes.rst
Outdated
Show resolved
Hide resolved
Documentation/gettingstarted/k8s-install-rancher-existing-nodes.rst
Outdated
Show resolved
Hide resolved
11591d7
to
d849033
Compare
Fixed the last 2 issues, thanks for reviewing @qmonnet |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're welcome!
A last few comments. While looking at other guides I realised we're missing the disclaimer at the top of the file, see my comment below. There's also a typo on the bash option (should be lowercase -c
, see below).
After that, it should be all from my side. I built the doc locally and tested that everything works as expected. The doc build fine and is linked from the list of GSG, and the links to the pictures are correct and consistent with the walk-through, all good on that side :)
Documentation/gettingstarted/k8s-install-rancher-existing-nodes.rst
Outdated
Show resolved
Hide resolved
d849033
to
813cf69
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me now, thanks a lot! Could you please squash your two commits into a single one?
Signed-off-by: Sean Winn <sean@isovalent.com>
813cf69
to
52c014c
Compare
@qmonnet all squashed and ready, thanks again |
Signed-off-by: Sean Winn sean@isovalent.com
Adds a getting started guide for Rancher 2.x using Existing Nodes