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

Getting Started page recommends k3d without a reference to required k3d configuration #1171

Closed
brooke-hamilton opened this issue Jul 29, 2024 · 1 comment · Fixed by #1201
Labels
bug Something isn't working important This item is a high priority Issue we intend to address as soon as possible triaged

Comments

@brooke-hamilton
Copy link
Contributor

brooke-hamilton commented Jul 29, 2024

URL of the docs page
https://docs.radapp.io/getting-started/#1-have-your-kubernetes-cluster-handy

How is it currently worded?
"If you don’t have a preferred way to create Kubernetes clusters, you could try using k3d, which runs a minimal Kubernetes distribution in Docker."

How should it be worded?
Add a sentence similar to "If you use k3d be sure to apply our recommended configuration."

Screenshots
This section encourages users to try k3d...
image

But this configuration is also required:
image

Additional context
Without the port mapping to port 80 in k3d, the first tutorial will not work.

The simplest path to success for me in that tutorial was to enable the Kubernetes feature in Docker Desktop. We could also provide that recommendation in the getting started page, i.e., "if you are already using Docker Desktop, you can enable the Kubernetes feature."

AB#12907

@brooke-hamilton brooke-hamilton added the bug Something isn't working label Jul 29, 2024
Copy link

azure-boards bot commented Jul 29, 2024

✅ Successfully linked to Azure Boards work item(s):

@ytimocin ytimocin added triaged important This item is a high priority Issue we intend to address as soon as possible labels Aug 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working important This item is a high priority Issue we intend to address as soon as possible triaged
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants