-
Notifications
You must be signed in to change notification settings - Fork 16
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: add rancher ui installation instructions #75
docs: add rancher ui installation instructions #75
Conversation
Mostly looks good, can we remove "Operator" word from the uninstall page as well to be consistent with install? |
c5c9260
ebe033e
to
c5c9260
Compare
I updated the changes and modified the uninstall section title + added a warning related to not using the UI when installing Cluster API Operator separately. |
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. Just one comment around switching the order.
Signed-off-by: Carlos Salas <[email protected]>
c5c9260
to
e5feb2a
Compare
I will address any open comments on this one since @salasberryfin will be on PTO next week. |
I also removed all "operator" word from Rancher Turtles mentions in the latest docs (excluding the ones in versioned_docs/* folder) to align on what we agreed in #75 (comment) |
98d5b38
to
983dafd
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. Just a couple of minor comments.
docs/getting-started/install-rancher-turtles/using_rancher_dashboard.md
Outdated
Show resolved
Hide resolved
@@ -14,11 +14,11 @@ To simplify uninstalling Rancher Turtles (via Rancher Manager or helm command), | |||
- Delete the CAPI `deployments` that are no longer needed. | |||
::: | |||
|
|||
There are two options to uninstall the Rancher Turtles Operator depending on the installation method. | |||
There are two options to uninstall the Rancher Turtles depending on the installation method. |
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.
As discussed we will only mention uninstalling via helm on the cli initially. But this can be changed in #77. wdyt @furkatgofurov7 @Danil-Grigorev?
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.
Let's change it in #77 👍🏼
Signed-off-by: Furkat Gofurov <[email protected]>
…st version (unversioned) of docs Signed-off-by: Furkat Gofurov <[email protected]>
983dafd
to
6c79423
Compare
Description
This PR adds instructions for installing the Turtles Helm chart via Rancher UI (adding the repository and then installing the chart via the local cluster). This is the same installation process we use in the demos and it's a simpler alternative to installing it manually via
helm install
.With this change, the installation options are grouped into two different categories:
The UI installation is now the recommended approach and links from other pages in the docs point to this option. It also includes a GIF demo to visually show how the extension is installed.
What does it look like?
Fixes: #73