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

Choosing an installation method documentation #933

Merged
merged 3 commits into from
Jan 9, 2025

Conversation

louiseschmidtgen
Copy link
Contributor

@louiseschmidtgen louiseschmidtgen commented Jan 8, 2025

Choosing an installation method documentation

This PR adds an explanation page on the different installation methods available: Snap, Juju and CAPI.

@louiseschmidtgen louiseschmidtgen marked this pull request as ready for review January 8, 2025 13:05
@louiseschmidtgen louiseschmidtgen requested a review from a team as a code owner January 8, 2025 13:05
Copy link
Contributor

@nhennigan nhennigan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a good place for this explanation page. I intend on linking to this page from the home page. This page is generic across installation types so we could use an {include} statement and put it in the capi and charm trees too.

update their software.

If you are looking for a straightforward way to get started with {{ product }},
and you don't intend to grow your cluster beyond a single node, installing
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can have multi-node with the snap it is just less convenient to manage. I would rephrase to something like
"If you are looking for a straightforward way to get started with {{ product }}, using the snap is the recommended installation method. Follow the
[getting-started guide] to install {{ product }} using the snap. If you intend to grow your cluster beyond a few nodes, it is recommend deploying {{product}} with Juju due to the ease of cluster management at scale."

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should add:

This is the recommended installation method for development environments.

?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we should add development environments, it will scare people away thinking this isn't production ready...

docs/canonicalk8s/index.md Outdated Show resolved Hide resolved
docs/src/snap/explanation/installation-methods.md Outdated Show resolved Hide resolved
Copy link
Member

@berkayoz berkayoz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work, LGTM overall left a minor comment

docs/src/snap/explanation/installation-methods.md Outdated Show resolved Hide resolved
docs/src/snap/explanation/installation-methods.md Outdated Show resolved Hide resolved
update their software.

If you are looking for a straightforward way to get started with {{ product }},
and you don't intend to grow your cluster beyond a single node, installing
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should add:

This is the recommended installation method for development environments.

?

docs/src/snap/explanation/installation-methods.md Outdated Show resolved Hide resolved
@louiseschmidtgen
Copy link
Contributor Author

I think this is a good place for this explanation page. I intend on linking to this page from the home page. This page is generic across installation types so we could use an {include} statement and put it in the capi and charm trees too.

@nhennigan Did I get the pages right?

@louiseschmidtgen louiseschmidtgen merged commit 29b72dd into main Jan 9, 2025
6 checks passed
@louiseschmidtgen louiseschmidtgen deleted the KU-2402/choose-install-method branch January 9, 2025 15:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants