Skip to content

Proposal: Add “Before You Begin” section with online lab options to Helm docs #1719

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

Open
abhi-bhatra opened this issue Apr 23, 2025 · 2 comments · May be fixed by #1722
Open

Proposal: Add “Before You Begin” section with online lab options to Helm docs #1719

abhi-bhatra opened this issue Apr 23, 2025 · 2 comments · May be fixed by #1722

Comments

@abhi-bhatra
Copy link

Description:

Hi Helm team! 👋
I’d like to propose adding a “Before You Begin” or “Prerequisites” section to Helm tutorials and task pages, similar to what the official Kubernetes documentation provides (see: example)

This section would help new learners get started quickly by offering links to interactive Kubernetes playgrounds where Helm can be practiced without needing a local cluster setup.

Suggested Content:

To follow this tutorial, you need access to a Kubernetes cluster with Helm installed. If you don’t already have one, you can use one of the following cloud-based Kubernetes playgrounds:

These environments provide temporary clusters to test Helm commands without needing to set up a local cluster or cloud environment.

Benefits:

  • Lowers the barrier to entry for beginners
  • Aligns Helm documentation style with Kubernetes Docs best practices
  • Increases visibility for Helm education through interactive labs

Let me know your thoughts, happy to collaborate or raise a PR for this if it makes sense.

Thanks for all the great work you do on Helm! 🙏

@TerryHowe
Copy link
Contributor

Thanks for moving this. A PR would be welcome of course

@abhi-bhatra
Copy link
Author

Thanks @TerryHowe ! I will draft a PR for this

@abhi-bhatra abhi-bhatra linked a pull request May 9, 2025 that will close this issue
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 a pull request may close this issue.

2 participants