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

[DPE-5355] Deployment docs for AKS + EKS #146

Closed
wants to merge 8 commits into from

Conversation

deusebio
Copy link
Contributor

Deployment docs for Azure AKS, taked and readapted from https://discourse.charmhub.io/t/topic/14307

@marcoppenheimer marcoppenheimer changed the title [DPE-5355] Deployment docs for AKS [DPE-5355] Deployment docs for AKS + EKS Oct 21, 2024
Copy link

@grobbie grobbie left a comment

Choose a reason for hiding this comment

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

pretty good but some changes needed here and there

docs/how-to/h-deploy-aks.md Outdated Show resolved Hide resolved
docs/how-to/h-deploy-aks.md Outdated Show resolved Hide resolved
docs/how-to/h-deploy-aks.md Outdated Show resolved Hide resolved
docs/how-to/h-deploy-aks.md Outdated Show resolved Hide resolved
docs/how-to/h-deploy-aks.md Show resolved Hide resolved
docs/how-to/h-deploy-eks.md Outdated Show resolved Hide resolved
docs/how-to/h-deploy-eks.md Show resolved Hide resolved
docs/how-to/h-deploy-eks.md Outdated Show resolved Hide resolved
docs/how-to/h-deploy-eks.md Show resolved Hide resolved
docs/how-to/h-deploy-eks.md Outdated Show resolved Hide resolved
Copy link
Contributor

@izmalk izmalk left a comment

Choose a reason for hiding this comment

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

Can we implement similar suggestions to the canonical/kafka-operator#256 PR?

@deusebio
Copy link
Contributor Author

@izmalk @grobbie I have now revised the text. Given we were using a lot of output, I found it beneficial to try and use the details block to provide a kinda optional box to show the outputs as done here.

Copy link
Contributor

@izmalk izmalk left a comment

Choose a reason for hiding this comment

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

Good job. Especially with these note blocks. Made a few suggestions to improve. Nothing blocking.

docs/how-to/h-deploy-aks.md Show resolved Hide resolved
docs/how-to/h-deploy-aks.md Show resolved Hide resolved
docs/how-to/h-deploy-aks.md Show resolved Hide resolved
docs/how-to/h-deploy-aks.md Show resolved Hide resolved
docs/how-to/h-deploy-aks.md Show resolved Hide resolved
docs/how-to/h-deploy-eks.md Show resolved Hide resolved
docs/how-to/h-deploy-eks.md Outdated Show resolved Hide resolved
Create an IAM account (or use legacy access keys) and login to AWS:

```shell
> aws configure
Copy link
Contributor

Choose a reason for hiding this comment

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

Not a biggie, but can we fix the usage of the prompt for combining input and output here, since we do it everywhere else? As far as I can see this is the last place to fix it (remove the > and split output from input with proper introduction.

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 actually purposely didn't want to do that since it is not JUST output. The lines below should also provide guidance on how to feed the inputs (although I know it is obvious), and we actually use placeholder instead of just taking the output of a screen

docs/how-to/h-deploy-eks.md Outdated Show resolved Hide resolved
docs/how-to/h-deploy-aks.md Outdated Show resolved Hide resolved
deusebio and others added 2 commits November 27, 2024 23:09
@deusebio
Copy link
Contributor Author

Content copy and pasted to Discourse. This PR is superseded by #155

@deusebio deusebio closed this Nov 27, 2024
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.

4 participants