Add Minikube Setup Instructions to Quickstart Documentation#6802
Add Minikube Setup Instructions to Quickstart Documentation#6802vedantlavale wants to merge 7 commits into
Conversation
…r dev, 0.56.x and v1.0.x Signed-off-by: vedantlavale <vedantlavale@gmail.com>
Signed-off-by: vedantlavale <vedantlavale@gmail.com>
8e96300 to
5791a3b
Compare
|
@khanhtc1202 @Ayushmore1214 @rahulshendre could you please review this new PR? lmk if any change |
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds Minikube-based local Kubernetes cluster setup instructions to the Quickstart docs so new users can satisfy the “have a cluster” prerequisite without external guidance.
Changes:
- Document Minikube installation steps for macOS/Linux/Windows.
- Add cluster start + verification commands (
minikube start,kubectl cluster-info,kubectl get nodes). - Add brief troubleshooting guidance and links to Minikube docs.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| docs/content/en/docs-v1.0.x/quickstart/_index.md | Adds Minikube setup section under prerequisites for v1.0.x quickstart. |
| docs/content/en/docs-dev/quickstart/_index.md | Adds Minikube setup section under prerequisites for docs-dev quickstart. |
| docs/content/en/docs-v0.56.x/quickstart/_index.md | Backports Minikube setup section to v0.56.x quickstart. |
| docs/content/en/docs-v0.55.x/quickstart/_index.md | Backports Minikube setup section to v0.55.x quickstart. |
Ayushmore1214
left a comment
There was a problem hiding this comment.
And one more thing as this a site/docs based change, we might need a screenshot of this after running it locally, this is going to be a compulsion soon about the screenshot!
Yeah sure |
Signed-off-by: vedantlavale <vedantlavale@gmail.com>
|
@vedantlavale checked your screenshot there seems to be a lot of space in the upper side of the command box, is there any way we can fix that ? no worries if we don't either way looks good to me, was thinking of better user experience |
|
yeah the extra space above the code blocks is coming from the new global copy button styling, not from the Markdown in this section. It affects all code blocks across the docs, so I didn’t adjust it here. If you’d like, I can open a separate follow‑up to tweak the global code block spacing so it looks tighter |
yes, @vedantlavale it was recently added, but before making any changes let's wait some time for maintainer feedback and most importantly user feedback ref |
rahulshendre
left a comment
There was a problem hiding this comment.
LGTM
Thanks @vedantlavale
What this PR does
Adds Minikube setup guidance to the Quickstart documentation across multiple versions (v1.0.x, v0.56.x, v0.55.x, and docs-dev). This includes a link to the official installation guide, cluster startup instructions, verification steps, and troubleshooting links.
Why we need it
The current Quickstart documentation requires users to have "a running Kubernetes cluster" but provides no guidance on how to set one up. This creates a barrier to entry for new users who:
This change removes that friction and helps users get started with PipeCD more quickly.
Which issue(s) this PR fixes
Fixes #6800
Does this PR introduce a user-facing change?
Yes
How are users affected by this change
Users following the Quickstart guide will now have clear, actionable instructions for setting up a local Kubernetes cluster using Minikube. This significantly reduces friction for first-time users and lowers the barrier to entry for PipeCD adoption.
Is this breaking change
No
How to migrate (if breaking change)
N/A
Additional Context
Updated 4 documentation versions consistently:
Installation: Single link to the official Minikube installation guide
Troubleshooting: Links to the Minikube drivers and docs pages
User experience: Clear step-by-step flow from installation to verification
Files Changed
docs/content/en/docs-v1.0.x/quickstart/_index.mddocs/content/en/docs-dev/quickstart/_index.mddocs/content/en/docs-v0.56.x/quickstart/_index.mddocs/content/en/docs-v0.55.x/quickstart/_index.mdTesting
Verified that:
Screenshots