Skip to content
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

Merged
merged 1 commit into from
Mar 10, 2021

Conversation

seanmwinn
Copy link
Contributor

Signed-off-by: Sean Winn sean@isovalent.com

Adds a getting started guide for Rancher 2.x using Existing Nodes

Adds a Getting Started Guide for Rancher 2.x using Existing Nodes

@seanmwinn seanmwinn requested a review from a team as a code owner March 2, 2021 23:06
@seanmwinn seanmwinn requested a review from qmonnet March 2, 2021 23:06
@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Mar 2, 2021
@maintainer-s-little-helper maintainer-s-little-helper bot added this to In progress in 1.10.0 Mar 2, 2021
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from master in 1.8.8 Mar 2, 2021
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from master in 1.9.5 Mar 2, 2021
@aanm aanm added the release-note/misc This PR makes changes that have no direct user impact. label Mar 3, 2021
@maintainer-s-little-helper maintainer-s-little-helper bot removed the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Mar 3, 2021
Copy link
Member

@qmonnet qmonnet left a 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?

Documentation/gettingstarted/rancher.rst Outdated Show resolved Hide resolved
Documentation/gettingstarted/rancher.rst Outdated Show resolved Hide resolved
Documentation/gettingstarted/rancher.rst Outdated Show resolved Hide resolved
Documentation/gettingstarted/rancher.rst Outdated Show resolved Hide resolved
Documentation/gettingstarted/rancher.rst Outdated Show resolved Hide resolved
Documentation/gettingstarted/rancher.rst Outdated Show resolved Hide resolved
@seanmwinn seanmwinn force-pushed the pr/seanmwinn/rancher_guide branch 2 times, most recently from 4ec465f to e44338f Compare March 8, 2021 22:00
@seanmwinn seanmwinn requested a review from qmonnet March 8, 2021 22:04
@seanmwinn seanmwinn force-pushed the pr/seanmwinn/rancher_guide branch 4 times, most recently from e2ab269 to 11591d7 Compare March 8, 2021 22:30
Copy link
Member

@qmonnet qmonnet left a 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!

@seanmwinn
Copy link
Contributor Author

Fixed the last 2 issues, thanks for reviewing @qmonnet

Copy link
Member

@qmonnet qmonnet left a 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 :)

Copy link
Member

@qmonnet qmonnet left a 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?

@joestringer joestringer added this to Needs backport from master in 1.8.9 Mar 9, 2021
@joestringer joestringer removed this from Needs backport from master in 1.8.8 Mar 9, 2021
Signed-off-by: Sean Winn <sean@isovalent.com>
@seanmwinn
Copy link
Contributor Author

@qmonnet all squashed and ready, thanks again

@qmonnet qmonnet added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Mar 10, 2021
@kkourt kkourt merged commit 2b6e04f into master Mar 10, 2021
1.10.0 automation moved this from In progress to Done Mar 10, 2021
@kkourt kkourt deleted the pr/seanmwinn/rancher_guide branch March 10, 2021 08:45
@joestringer joestringer removed this from Needs backport from master in 1.8.9 Mar 10, 2021
@joestringer joestringer added this to Backport done to v1.8 in 1.8.8 Mar 10, 2021
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Needs backport from master to Backport pending to v1.9 in 1.9.5 Mar 10, 2021
@christarazi christarazi added this to Backport pending to v1.9 in 1.9.6 Mar 10, 2021
@christarazi christarazi removed this from Backport pending to v1.9 in 1.9.5 Mar 10, 2021
@joestringer joestringer removed this from Backport pending to v1.9 in 1.9.6 Mar 10, 2021
@joestringer joestringer added this to Backport done to v1.9 in 1.9.5 Mar 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-note/misc This PR makes changes that have no direct user impact.
Projects
No open projects
1.8.8
Backport done to v1.8
1.9.5
Backport done to v1.9
Development

Successfully merging this pull request may close these issues.

None yet

7 participants