Skip to content

Instantly share code, notes, and snippets.

@flynnduism

flynnduism/helm-www-readme.md

Created January 21, 2020 22:16
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save flynnduism/3a985aa5a7a38863c9284027b19a6577 to your computer and use it in GitHub Desktop.
Save flynnduism/3a985aa5a7a38863c9284027b19a6577 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
helm-www-readme.md

github-banner-helm-helmwww

This is where you'll find all of the assets that make up helm.sh, the website for the Helm 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!

Development

Helm.sh is a simple Hugo static site, built with a custom theme. To run the website locally, you'll need to first install Hugo and any dependencies.

brew install hugo
yarn install

You can then compile and run the site locally:

hugo serve

Deployment Netlify Status

Changes are automatically deployed to Netlify when merged to master. Build logs can be found here.

Contributing

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

Pull requests require maintainer approval before merge.

How to Edit The Helm Docs

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

Updating the Helm CLI Reference Docs

The documentation for the list of Helm CLI Commands are exported from the main helm project repo and rendered here on the website as a reference.

To update the CLI command docs, you'll need to:

  1. Go to the helm/helm repo and fetch the latest master.
  2. Run helm docs --type markdown to generate the markdown docs files
  3. Copy the generated files (helm.md, helm_create.md, etc)
  4. Return to the helm/helm-www repo and navigate to content/en/docs/helm/
  5. Paste the latest CLI command docs here, replacing any prior markdown files
  6. Commit the changes and create a PR to update the website.

How to Write a Blog Post

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

  1. Add a new file to the content/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 are authorname which should be name(s); these are displayed verbatim. authorlink is the link used by authorname.
---
title: "A Fancy Title"
slug: "fancy-title"
authorname: "Captain Awesome"
authorlink: "https://example.com"
date: "yyyy-mm-dd"
---
  1. Add the content below the --- as Markdown. The title does not need to be included in this section
  2. Any images should be placed in the /img/blog/ directory. Images should be losslessly compressed to reduce their size. Tools, such as ImageOptim, can be used.
  3. To summarize the content on the blog index page, insert a <!--more--> break in your markdown. This will truncate the content with a Read More link.

Blog PRs require approval from the core Helm maintainers before merge.

Code of Conduct

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

Thank You!

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment