search

radius-project / docs

Documentation for Radius
https://docs.radapp.io
Apache License 2.0
24 stars 41 forks source link

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

Open brooke-hamilton opened 1 month ago

brooke-hamilton commented 1 month ago

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

azure-boards[bot] commented 1 month ago

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