Repository files navigation

This is where you'll find all of the assets that make uphelm.sh, the website for theHelm project. If you'll looking to edit docs, report a website bug or write a new blog post, you've come to the right place!

Helm.sh is a simpleHugo static site, built with a custom theme. To run the website locally, you'll need to firstinstall Hugo extended edition and any dependencies.

brew install hugoyarn install

You can then compile and run the site locally:

hugo serve

Changes are automatically deployed toNetlify when merged tomain. Build logs can be foundhere.

Anyone can submit a PR to edit Helm.sh. We require commits be signed - please refer to thecontributing guide.

Pull requests requiremaintainer approval before merge.

Since the release of Helm 3, all project documentation is located in this repo under/content/en/docs/.

For earlier versions, see the dev-v2 branch of the main Helm repohere.

The documentation for the list of Helm CLI Commands areexported from the main helm project repo and renderedhere on the website as a reference.

To update these docs, you'll need to:

1. Delete all plugins currently installed withhelm plugin uninstall
2. Navigate tocontent/en/docs/helm/
3. RunHOME='~' helm docs --type markdown --generate-headers to generate the markdown docs files, replacing any prior markdown files.Note: Make sure you run the version of helm you want to build the docs for (for example, by checking out the correct tag and building it)
4. Commit the changes and create a PR to update the website.

Blog posts are created via pull requests. The following steps are used to add them:

1. Add a new file to thecontent/en/blog/ directory whose name is the published date and the title. The files must be markdown formatted. See the existing titles for examples of the format
2. Add the header meta-data to the file using this format (note the permalink structure). Recommended but optional fields areauthorname which should be name(s); these are displayed verbatim.authorlink is the link used byauthorname.

---title:"A Fancy Title"slug:"fancy-title"authorname:"Captain Awesome"authorlink:"https://example.com"date:"yyyy-mm-dd"---

3. Add the content below the--- as Markdown. The title does not need to be included in this section
4. Any images should be placed in the/content/en/blog/images/ directory. Images should be losslessly compressed to reduce their size. Tools, such asImageOptim, can be used.
5. To summarize the content on the blog index page, insert a<!--more--> break in your markdown. This will truncate the content with aRead More link.

Blog PRs require approval from the core Helmmaintainers before merge.

We welcome content translations to our site and our docs, to help expand access to Helm around the world.

Helm.sh supports multiple languages. Please refer to theLocalizing Helm Documentation for a guide on translating and configuring content for international users.

Participation in the Helm community is governed by the HelmCode of Conduct.

We appreciate your contributions to our website and our documentation! 👏