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: add rancher ui installation instructions #75

Conversation

salasberryfin
Copy link
Contributor

@salasberryfin salasberryfin commented Mar 27, 2024

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:

  • Via UI
  • Via Helm install

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?

image
image
image

Fixes: #73

@salasberryfin salasberryfin added area/documentation Improvements or additions to documentation kind/enhancement New feature or request labels Mar 27, 2024
@furkatgofurov7
Copy link
Contributor

Mostly looks good, can we remove "Operator" word from the uninstall page as well to be consistent with install?

Danil-Grigorev
Danil-Grigorev previously approved these changes Mar 27, 2024
@salasberryfin salasberryfin force-pushed the add-rancher-ui-installation-instructions branch from ebe033e to c5c9260 Compare March 27, 2024 14:52
@salasberryfin
Copy link
Contributor Author

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.

furkatgofurov7
furkatgofurov7 previously approved these changes Mar 27, 2024
Copy link
Contributor

@richardcase richardcase 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. Just one comment around switching the order.

docs/getting-started/intro.md Outdated Show resolved Hide resolved
@furkatgofurov7 furkatgofurov7 force-pushed the add-rancher-ui-installation-instructions branch from c5c9260 to e5feb2a Compare March 28, 2024 14:11
@furkatgofurov7
Copy link
Contributor

I will address any open comments on this one since @salasberryfin will be on PTO next week.

@furkatgofurov7
Copy link
Contributor

furkatgofurov7 commented Mar 28, 2024

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)

@furkatgofurov7 furkatgofurov7 force-pushed the add-rancher-ui-installation-instructions branch 2 times, most recently from 98d5b38 to 983dafd Compare March 28, 2024 14:40
Copy link
Contributor

@richardcase richardcase 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. Just a couple of minor comments.

@@ -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.
Copy link
Contributor

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?

Copy link
Contributor

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]>
@furkatgofurov7 furkatgofurov7 force-pushed the add-rancher-ui-installation-instructions branch from 983dafd to 6c79423 Compare April 2, 2024 11:27
@richardcase richardcase merged commit 21ac4d3 into rancher:main Apr 2, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation kind/enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add installation instructions via UI
5 participants