Skip to content

docs: Modernize Quickstart Guide with OCI-native workflow#2098

Merged
TerryHowe merged 8 commits into
helm:mainfrom
Promptless:promptless/quickstart-oci-native-workflow
May 10, 2026
Merged

docs: Modernize Quickstart Guide with OCI-native workflow#2098
TerryHowe merged 8 commits into
helm:mainfrom
Promptless:promptless/quickstart-oci-native-workflow

Conversation

@promptless-for-oss

Copy link
Copy Markdown
Contributor

Open this suggestion in Promptless to view citations and reasoning process

Replaces Bitnami chart repository examples with vendor-neutral approaches. The guide now teaches users to: (1) create their own chart with helm create to learn core concepts without external dependencies, (2) install charts from OCI registries using the oci:// prefix, and (3) discover charts via Artifact Hub. This addresses issue #1752 where Bitnami charts became unavailable behind a paywall, while also aligning with Helm's direction toward OCI as the primary distribution mechanism.

Trigger Events

  • [Slack mention: <@U0B148CFR89> yes](https://Writing Day 2026.slack.com/archives/C0B09SGLS07/p1777850928775599)
  • [Slack listen message in C0B09SGLS07: Yes, draft the Helm Quickstart OCI-based documentation changes so that i can create a PR](https://Writing Day 2026.slack.com/archives/C0B09SGLS07/p1777850928775599)

Tip: Whenever you leave a comment tagged @Promptless on a Promptless PR, Promptless will remember it for future suggestions 🧠

Replace Bitnami chart examples with vendor-neutral approaches:
- Use helm create to teach chart basics without external dependencies
- Add OCI registry installation example using oci:// prefix
- Add section on finding charts via Artifact Hub
- Remove deprecated helm repo add workflow from main tutorial path

This addresses issue helm#1752 where Bitnami charts became unavailable.
Comment thread docs/intro/quickstart.md
You get a simple idea of the features of this MySQL chart by running `helm show
chart bitnami/mysql`. Or you could run `helm show all bitnami/mysql` to get all
information about the chart.
## Install a Chart from an OCI Registry

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Added OCI registry section to replace Bitnami examples. Issue #1752 confirms Bitnami charts are behind a paywall since August 2025, and maintainer @TerryHowe suggested using OCI registries as the modern approach.

Source: #1752

Comment thread docs/intro/quickstart.md Outdated
For more details, or for other options, see [the installation guide](/intro/install.mdx).

## Initialize a Helm Chart Repository
## Create Your First Chart

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Used helm create approach from PR #1982 as the foundation for the local chart workflow. Extended it with OCI registry examples per maintainer feedback in issue #1752.

Source: #1982

@TerryHowe

Copy link
Copy Markdown
Contributor

@promptless-for-oss 4:14:16 PM: - Broken link on source page path = /docs/intro/quickstart: 4:14:16 PM: -> linking to /topics/registries.md

Update the link path to use Docusaurus-style routing without
file extension, matching the docs site URL structure.
@promptless-for-oss

Copy link
Copy Markdown
Contributor Author

Thanks for catching that @TerryHowe! I've fixed the broken link — it now points to /docs/topics/registries instead of /topics/registries.md. The link checker should pass now.

Comment thread docs/intro/quickstart.md Outdated
Comment on lines +136 to +152
## Find Charts to Install

[Artifact Hub](https://artifacthub.io/packages/search?kind=0) is the best place to discover Helm charts. It aggregates charts from hundreds of repositories and provides search, metadata, and security information.

Popular chart sources include:

- **OCI registries**: Many organizations publish charts to container registries like GitHub Container Registry, Docker Hub, or cloud provider registries. You can install these directly with the `oci://` prefix.
- **Chart repositories**: Traditional Helm repositories can be added with `helm repo add` and searched with `helm search repo`.

To search Artifact Hub from the command line:

```console
$ helm search hub wordpress
URL CHART VERSION APP VERSION DESCRIPTION
https://artifacthub.io/packages/helm/bitnami/... 15.2.5 6.1.1 WordPress is the world's most popular blogging ...
```

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@promptless-for-oss it seems like it would make more sense to have this "Find Charts to Install" section before "Install a Chart from an OCI Registry" what do you think?

Addresses reviewer feedback to present chart discovery before
installation from external registries, creating a more logical
learning progression.
@promptless-for-oss

Copy link
Copy Markdown
Contributor Author

Good suggestion! I've reordered the sections so "Find Charts to Install" now comes before "Install a Chart from an OCI Registry". This creates a more logical flow: users learn where to discover charts before learning how to install them from external sources.

The new section order is:

  1. Create Your First Chart
  2. Install Your Chart
  3. Find Charts to Install
  4. Install a Chart from an OCI Registry
  5. Learn About Releases
  6. Uninstall a Release
  7. Reading the Help Text

@TerryHowe TerryHowe left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@promptless-for-oss Remove the "Create Your First Chart" section and the "Install Your Chart" sections.

Per reviewer feedback, removed these sections to streamline the quickstart.
Updated examples in "Learn About Releases" and "Uninstall a Release" to
reference the my-nginx release from the OCI install example.
@pull-request-size pull-request-size Bot added size/M and removed size/L labels May 10, 2026
@promptless-for-oss

Copy link
Copy Markdown
Contributor Author

Done! I've removed the "Create Your First Chart" and "Install Your Chart" sections from the quickstart guide. The guide now flows directly from installing Helm to finding and installing charts from Artifact Hub and OCI registries.

I also updated the examples in the later sections to reference my-nginx from the OCI install example for consistency.

Comment thread docs/intro/quickstart.md Outdated
$ helm install bitnami/mysql --generate-name
NAME: mysql-1612624192
LAST DEPLOYED: Sat Feb 6 16:09:56 2021
$ helm install my-nginx oci://ghcr.io/nginxinc/charts/nginx-ingress --version 2.0.1

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@promptless-for-oss can you change this example to use oci://ghcr.io/stefanprodan/charts/podinfo:6.11.2 as maybe my-podinfo and add some install validation like $ kubectl port-forward svc/my-podinfo 9898:9898 & $ curl http://localhost:9898 { "hostname": "podinfo-6f89b4c6b5-xvwtb", "version": "6.7.1", "message": "greetings from podinfo v6.7.1", "goos": "linux", "goarch": "amd64", ... }

Switch the OCI registry example from nginx-ingress to podinfo as
requested by reviewer. Add port-forward and curl validation steps
to demonstrate how to verify a successful installation.
@promptless-for-oss

Copy link
Copy Markdown
Contributor Author

Done! I've updated the OCI example to use podinfo:

  • Changed the install example to oci://ghcr.io/stefanprodan/charts/podinfo:6.11.2 with release name my-podinfo
  • Added install validation showing kubectl port-forward and curl to test the endpoint
  • Updated helm show chart to use podinfo
  • Updated all subsequent examples (helm list, helm uninstall, helm status) to reference my-podinfo

Comment thread docs/intro/quickstart.md Outdated
bitnami/apache 8.2.3 2.4.46 Chart for Apache HTTP Server
bitnami/aspnet-core 1.2.3 3.1.9 ASP.NET Core is an open-source framework create...
# ... and many more
$ helm search hub wordpress

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@promptless-for-oss can you change this example from wordpress to podinfo? Output would look like $ helm search hub podinfo URL CHART VERSION APP VERSION DESCRIPTION https://artifacthub.io/packages/helm/podinfo/po... 6.11.2 6.11.2 Podinfo Helm chart for Kubernetes

Change the Artifact Hub search example from wordpress to podinfo
for consistency with the rest of the guide, which now uses podinfo
as the example chart throughout.
@promptless-for-oss

Copy link
Copy Markdown
Contributor Author

Done! I've updated the helm search hub example from wordpress to podinfo for consistency with the rest of the guide. The example output now shows the podinfo chart from Artifact Hub.

@TerryHowe TerryHowe left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

/lgtm

@TerryHowe TerryHowe merged commit f2d84e0 into helm:main May 10, 2026
3 checks passed
@promptless-for-oss promptless-for-oss deleted the promptless/quickstart-oci-native-workflow branch May 10, 2026 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants