As of right now, https://www.helm.sh/blog/ does not redirect to https://www.helm.sh/blog/index.html. We originally did not require this because helm.sh was a single-page site. Now with the blog up, we should probably add some CDN rewrite rules so that we can tweet out cleaner URL links, much like the docs site can do via https://docs.helm.sh/using_helm/

I was replying in helm/charts#3591 and realized this is a much bigger problem that deserves a charts issue to decide whether we should agree on and document a policy for this across charts.

Can we address this at one of the next charts meetings?

Related:

• helm/charts#3591
• helm/charts#4258
• helm/helm#2721
• helm/helm#2196
• helm/charts#5129
• helm/charts#4472
• helm/charts#4965
• helm/charts#2538
• helm/charts#2636
• helm/helm#3053
• https://github.com/kubernetes/helm/blob/master/docs/charts_tips_and_tricks.md#automatically-roll-deployments-when-configmaps-or-secrets-change
• helm/charts#2488

Can we use the same styling for the blog as per rest of the site, as that dark blue background with the the white text is not nice for the eyes.

the current blog:

vs the rest of the site:

On the main doc webpage https://helm.sh/docs/using_helm, it sounds like at least the first links are broken :
https://helm.sh/docs/using_helm/#installing-helm
https://helm.sh/docs/using_helm/#quickstart

doc sounds to be correct on github side : https://github.com/helm/helm/blob/master/docs/using_helm.md

initially wrongly opened here for info : helm/helm#5376

Current status

The goal of me moving this issue is to be able to archive the helm/charts repo and make sure that the work started/pinned here makes its way into helm.sh/docs.

Some of this has already made it's way into the docs, but there are other valuable things collaborated on here which have not yet. It's been in the back of my mind for a while but I just haven't spent the time to move it to the docs. It may need another round of review by Charts team maintainers and others once we do, because k8s has moved a lot since then!

Original issue

Plan

From the past few Charts dev meetings, we all planned to collaborate on clarifying Charts best practices. There have been no PRs to do that thus far (as we approached and are now recovering from KubeCon), so in Today's meeting I volunteered to sketch up an issue to provide some structure to help us do this asynchronously.

The plan is to start with the lowest hanging fruit first, and iterate from there:

1. Sketch up a simple list - in this issue - pointing to which charts are good examples of items in the running list (this would be a good place to quickly note any caveats or questions we may have about those)
2. Make PR for adding documentation to REVIEW_GUIDELINES.md about each item in the running list
3. Once this is done, and announced, we could then iterate on adding some version of these best practices into chartutil's create command

Domains/Topics

The idea is to break out best practices by domain/topic (or some way of thinking about grouping k8s primitives and concepts as they map to helm/charts implementation). Here's a working list, with names of volunteers so far to work on them:

• PVCs/StorageClass @prydonius (see helm/charts#1869, helm/charts#4223)
• RBAC @unguiculus (helm/helm#3408)
  • kubernetes-sigs/aws-load-balancer-controller#146
  • helm/helm#3184
• Network policy @omkensey (issue helm/charts#4067 - needs a PR)
• StatefulSets @dhilipkumars helm/charts#3334
• Deployment @dhilipkumars helm/charts#3334
• Jobs @dhilipkumars helm/charts#3334
• ReplicaSet @dhilipkumars helm/charts#3334
• DaemonSet @dhilipkumars helm/charts#3334
• HorizontalPodAutoscaler @paulczar helm/charts#7562 (see https://github.com/helm/charts/issues/3011#issuecomment-417043738)
• Ingress @prydonius @scottrigby (#7590)
• Affinity/Antiaffinity (briefly mentioned in helm/charts#3334)
• ServiceAccount (see helm/helm#3320, helm/helm#3408)
• PodSecurityPolicy @paulczar
• PodDisruptionBudget (briefly mentioned in helm/charts#3334. See https://github.com/helm/charts/issues/3011#issuecomment-419233266)
• Label immutability (See helm/charts#7680, helm/charts#7803, helm/charts#7726) @desaintmartin
• Standard keys & terminology
  • Today (12 June 2018) discussed making this a new section in the Helm best practices conventions document, where we can distinguish the semantic meaning of create vs enable keys, etc.
• Standard commands
  • When to use include and template (See https://github.com/helm/charts/issues/3011#issuecomment-457637650, https://github.com/helm/charts/issues/3011#issuecomment-457640417, helm/helm#4092 and helm/helm#4093)
• Versioning @scottrigby (#11207)
• OWNERS file (We should note what was decided here helm/charts#7446 (comment) in the REVIEW_GUIDELINES)

Related issues

• helm/helm#1993
• helm/helm#2007
• helm/charts#44

Hello,

I have been using the docs website for only few hours and there is something that is going to make me crazy => scrolling the docs is a nightmare !!!

I don't know why but:

• after a while or when reaching a specific page's position scroll is blocked and then after some mouse wheel rotations it works again. That behaviour is just ugly. I feel like someone tied up my two shoes' shoelaces together. (or like this http://gph.is/1Sie7un)
• can't use arrows or page up/down for scrolling (at least firefox linux, chrome seems ok with that)

Hope you'll be able to do something for that 🙏

Thanks in advance,
Thomas

Having submitted this site and details on the embedded 3rd cookies to the cookie portal, this site will need a Cookie disclaimer message to comply with EU regulations.

• Sharepoint: Cookie Compliance Steps
• Sharepoint: Cookie Wiki
• MS Cookie Portal

In the section TILLER, NAMESPACES AND RBAC there's a bug.

It says,

You can find more information about that here.

here is a link to https://docs.helm.sh/using_helm/service_accounts but should be a link to https://docs.helm.sh/service_accounts since it's another document at the same level as https://docs.helm.sh/using_helm.

I'm filing the bug here because the markdown in the helm repo handles the location properly. I think this bug is part of the transform to turn it into the site.

What about updating the front page as per:

it would look better :)
cc @flynnduism

Recent merges to master are not being successfully pushed to prod (blob storage).

@vdice are you familiar with the Brigade pipeline here? I'm checking for logs but seeing a separate issue breaking our logging dashboard.

For now I've manually updated the site in blob storage.

If it's an easy fix we should restore Brigade - if it's looking complex, then I'll add another vote to switching this to Netlify.

I wasn't able to find a feed for the helm blog, I'd love to keep up with posts. Am I missing something or does this not exist yet?

original ticket: helm/helm#4607

On docs.helm.sh using firefox, I can only scroll using my mouse's scroll wheel. Arrow keys, page up/down are both broken.

Following on from #3940, there's an issue with styles not rendering on the domain root https://helm.sh. They work fine via www.helm.sh oddly.

*helm.sh -> www.helm.sh

I'd tried forwarding everything via www to circumvent this issue, but that routing isn't working. I've rolled back the DNS as a result.

Content-Type

@technosophos do you know if the brigade.js CI script assigns a Content-Type on upload?

I don't see any in the script, but it may be set on the CDN. Some useful notes in this blog post about the Content-Type defaults, which ideally would be:

• assign text/html to the root index.html
• assign text/css to the assets/css/* dir

👋 Team,

From npm audit:

┌───────────────┬──────────────────────────────────────────────────────────────┐
│ High          │ Regular Expression Denial of Service                         │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Package       │ minimatch                                                    │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Patched in    │ >=3.0.2                                                      │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Dependency of │ gulp-track-filenames [dev]                                   │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Path          │ gulp-track-filenames > minimatch                             │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ More info     │ https://npmjs.com/advisories/118                             │
└───────────────┴──────────────────────────────────────────────────────────────┘

See here for more details

See https://www.cncf.io/projects/website-guidelines/ for more detail

Enabled building docs for PR events.

Will require refactoring the brigade.js

Hello All!

Erm - I cant seem to scroll down on the helm docs anymore!

REPRO - go the below link and try to scroll down....

https://docs.helm.sh/developing_charts/#charts

Chrome, Edge, Internet Explorer - cannot scroll with wheel, arrow keys, pg-down, nothing.

Anyone else getting this? Reset browser to clean state and ctrl+f5 - still no ability to scroll.

I would raise a PR but I have no idea what is wrong!

Thanks,
Matt

The changes I made in #102 aren't resolving the deployment issues to blob storage. Brigly completes the site build, but the files on the storage + CDN aren't changing.

You can see the logs of the brigly builds here - here's an an example of one that ran and returned some errors.

@technosophos you may have a diagnosis based on the below

Running\n[brigade:k8s] default/helm-sh-01cfx7vg2abb3gnencm2fam69m phase Failed\n  
\u001b[0m\u001b[97m\u001b[41mError\u001b[0m\u001b[90m:\u001b[0m\u001b[37m \u001b[0m\u001b[97mPod helm-sh-01cfx7vg2abb3gnencm2fam69m failed to run to completion\u001b[0m\n
\u001b[0m  \u001b[0m\n
\u001b[0m  \u001b[0m\u001b[90m-\u001b[0m \u001b[0m\u001b[93mk8s.js\u001b[0m
\u001b[90m:\u001b[0m\u001b[93m417\u001b[0m\u001b[37m \u001b[0m\u001b[37mk.readNamespacedPod.then.response\u001b[0m\n
\u001b[0m  \u001b[0m  \u001b[0m\u001b[90m./dist/k8s.js:417:32\u001b[0m\n
\u001b[0m  \u001b[0m\n\u001b[0m\n
[brigade:app]   \u001b[0m\u001b[97m
Error\u001b[0m\u001b[90m:\u001b[0m\u001b[37m \u001b[0m\u001b[97m
job helm-sh(helm-sh-01cfx7vg2abb3gnencm2fam69m): Error: Pod helm-sh-01c
\u001b[0m  \u001b[0m\u001b
[97mfx7vg2abb3gnencm2fam69m failed to run to completion\u001b[0m\n
\u001b[0m  \u001b[0m\n\u001b[0m  \u001b[0m\u001b[90m-\u001b[0m \u001b[0m\u001b[93mbrigadier.js\u001b[0m\u001b[90m:\u001b[0m\u001b[93m56\u001b[0m\u001b[37m \u001b[0m\u001b[37mjr.run.catch.err\u001b[0m\n
\u001b[0m  \u001b[0m  \u001b[0m\u001b[90m./dist/brigadier.js:56:35\u001b[0m\n
\u001b[0m  \u001b[0m\n
\u001b[0m  \u001b[0m\n\u001b[0m  \u001b[0m\u001b[90m-\u001b[0m \u001b[0m\u001b[93mnext_tick.js\u001b[0m\u001b[90m:\u001b[0m\u001b[93m188\u001b[0m\u001b[37m \u001b[0m\u001b[37mprocess._tickCallback\u001b[0m\n
\u001b[0m  \u001b[0m  \u001b[0m\u001b[90minternal/process/next_tick.js:188:7\u001b[0m\n
\u001b[0m  \u001b[0m\n\u001b[0m\n
[brigade:app] error handler is cleaning up\n
[brigade:k8s] Destroying PVC named brigade-worker-01cfx7vg2abb3gnencm2fam69m\n
error Command failed with exit code 1.\n"

From the Helm project's root README.md file, follow the link to the Quick Start guide. We arrive at the intended anchor on the intended page, but from there several of the hyperlinks in the left sidebar (revealed via the blue-striped "hamburger menu") don't work.

It looks like they mistakenly include the URL path component "using_helm" when they should not.

• The "Using Helm" link is https://docs.helm.sh/using_helm/using_helm, which yields a 404 response.
• The "Helm Commands" link is https://docs.helm.sh/using_helm/helm, which yields a 404 response.
• The "Charts" link is https://docs.helm.sh/using_helm/developing_charts, which yields a 404 response.
• The "Developing Templates" link is https://docs.helm.sh/using_helm/chart_template_guide, which yields a 404 response.
• The "Best Practices" link is https://docs.helm.sh/chart_best_practices/ which doesn't get a response in a reasonable amount of time. (It came through after a couple of minutes.)
• The "Relate Projects" link is https://docs.helm.sh/related/ which doesn't get a response in a reasonable amount of time. (It came through after a couple of minutes.)

I'm not sure if this is related to the recent helm/helm#2645.

Seeing problematic caching on the docs site, an incomplete build was deployed.
See the layout here.

I've tried correcting this and pushing new builds / clearing the cache

• rebuilding the site via the Brigly bot
• manually uploading files to the blob storage
• purging the CDN and endpoint cache (many times!)

The correct version of the site is visible in blob storage (example here , 'Quickstart Guide' at the top rather than 'Using Helm'), but is not served via the CDN endpoint.

Investigating CDN settings.

Originally tracked this via issue #91 and addressed via PR #98, but the site hasn't updated fully with the fix.

Example: https://helm.sh/docs/helm/helm_upgrade/

This bug was filed in the main Helm repo:
helm/helm#4421

Some of the blog posts are off the root of the helm.sh site. Others are under blog. We need to be consistent and likely need a check to make sure we have it that way.

I propose we add a check that enforces a blog post have a prefix of /blog/.

This is especially a concern when you expand the "Helm Commands" nav button as it consumes the majority of the nav bar. Scrolling down on the main docs page does not help.

Flagged by @squillace - this url is broken, https://www.helm.sh/blog/page2/
looks like a CDN routing issue

The problem is that I am running minikube on MacOS, and want to expose the ip address and port for running this example helm chart. https://docs.bitnami.com/kubernetes/how-to/create-your-first-helm-chart/

I tried to ping the localhost:58064, but it wouldn't connect.

helm install --dry-run --debug ./mychart --set service.internalPort=8080
[debug] Created tunnel using local port: '58064'

[debug] SERVER: "127.0.0.1:58064"

[debug] Original chart version: ""
[debug] CHART PATH: /Users/me/Desktop/HelmTest/mychart

NAME: messy-penguin
REVISION: 1
RELEASED: Tue Jun 12 17:56:41 2018
CHART: mychart-0.1.0
USER-SUPPLIED VALUES:
service:
internalPort: 8080

COMPUTED VALUES:
affinity: {}
image:
pullPolicy: IfNotPresent
repository: nginx
tag: stable
ingress:
annotations: {}
enabled: false
hosts:

• chart-example.local
  path: /
  tls: []
  nodeSelector: {}
  replicaCount: 1
  resources: {}
  service:
  internalPort: 8080
  port: 80
  type: ClusterIP
  tolerations: []

HOOKS:
MANIFEST:

Source: mychart/templates/service.yaml

apiVersion: v1
kind: Service
metadata:
name: messy-penguin-mychart
labels:
app: mychart
chart: mychart-0.1.0
release: messy-penguin
heritage: Tiller
spec:
type: ClusterIP
ports:
- port: 80
targetPort: http
protocol: TCP
name: http
selector:
app: mychart
release: messy-penguin

Source: mychart/templates/deployment.yaml

apiVersion: apps/v1beta2
kind: Deployment
metadata:
name: messy-penguin-mychart
labels:
app: mychart
chart: mychart-0.1.0
release: messy-penguin
heritage: Tiller
spec:
replicas: 1
selector:
matchLabels:
app: mychart
release: messy-penguin
template:
metadata:
labels:
app: mychart
release: messy-penguin
spec:
containers:
- name: mychart
image: "nginx:stable"
imagePullPolicy: IfNotPresent
ports:
- name: http
containerPort: 80
protocol: TCP
livenessProbe:
httpGet:
path: /
port: http
readinessProbe:
httpGet:
path: /
port: http
resources:
{}
MacBook-Pro:~/Desktop/HelmTest quantum-fusion$ curl 127.0.0.1:58064
curl: (7) Failed to connect to 127.0.0.1 port 58064: Connection refused

Not related to helm specifically but visiting the website causing my CPU to spike and stay there until closing it. It's not just the home page either, other pages seem to have the same problem.

@bacongobbler suggested in helm/helm#3959 that it might be the animations. I think he might be correct on that one.

It should be considered a high priority issue though because leaving this page open in any browser tab is going to kill a notebook battery in a hurry.

There are plans to shut this down in March, so we should migrate the CI system off to CircleCI or some other CI system.

context: https://deis.com/blog/2017/deis-workflow-final-release/

Reported in Slack:

Access to Font at 'https://www.helm.sh/assets/fonts/klinicslabmedium-webfont.woff2' from origin 'https://helm.sh' has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource. Origin 'https://helm.sh' is therefore not allowed access.

This repo is still lacking in CI/CD. Setup should be very similar to what is currently in place for deis.io; see pr/master build job and deployment job.

One approach would be to copy, with slight modifications, those two jobs to suit the purposes of this repo.

Another, perhaps preferable approach, would be to switch to use of Jenkins Pipeline (Jenkinsfile in each repo), here and in deis/deis.io, both sharing/re-using a common set of functionality defined in a Pipeline Shared Library.

(A concrete example of such a library can be found in https://github.com/lachie83/jenkins-pipeline/blob/master/src/io/estrado/Pipeline.groovy.)

Let's give the latter a go and fallback to 'Plan B' if necessary.

There is a broken link here: https://docs.helm.sh/using_helm/#the-helm-plugins-guide

'Existing plugins can be found on related section or by searching Github'

Related is linking to https://docs.helm.sh/using_helm/related.md#helm-plugins

Related to #47, suggestion from @vdice.

The side menu home link is currently set to docs.helm.sh, using a hard-coded link instead of a relative parameter from Hugo.

Currently, the site.baseurl param can't be used in config.toml, but there's likely another easy way to make this a relative link so it works better in local development and staging.

From @timthelion:

If I go to https://docs.helm.sh/chart_template_guide/#the-chart-template-developer-s-guide the page has no title. This means that in google search results the title is listed as the first element on the page, which is "Helm Logo". It also looks weird if I bookmark it.

I'm seeing the same behavior described in #51. Clicking any of the links under "Using Helm" (like https://docs.helm.sh/using_helm/#quickstart-guide ) results in the browser loading a page with the header "Using Helm" but none of the expected information.

Code blocks need some ❤️ on the blog. code and pre tags need styles to add padding, adjust sizing, shading etc.

Screenshots:

This is related to #124 - I'd like to spend some time cleaning up the blog layout for a better reading experience (invert colors to dark text on white background).

See issue #2698.

@slack flagged an issue with the docs site not rendering properly, looks like the build task didn't fully run and the page is a mess. Half of the Using Helm subsections render correctly, but then the content column ends prematurely.

The second half of the page content is injected at the end of the page as raw html just before the closing tag.

To fix this I'm reviewing the build task sequence and enforcing a delay to ensure everything completes properly. It's likely the git clone task that fetches the doc content from the Kubernetes/Helm repo is messing up the task order.

#118 mentions Helm as CNCF inception project, which is an incorrect statement ("inception" is the old name of "sandbox").

The correct statement is "We are a Cloud Native Computing Foundation incubating project."

Current status

The goal of me moving this issue is to be able to archive the helm/charts repo and make sure that the work started/pinned here makes its way into helm.sh/docs.

Original issue

Now that we're moving charts to distributed Helm repos to be listed on the Hub, people need some guidance

The docs site renders the RBAC section as https://docs.helm.sh/using_helm/#role-based-access-control, but there is url in the Quick Start Guide that points to /rbac.

This works fine when browsing the docs on github.com/kubernetes/helm, but doesn't work on the Hugo rendered version of the docs site here. Thanks to @slack for flagging this.

This is easily remedied via the build pipeline, which runs some find and replace tasks to adapt the markdown files to work with Hugo.

Browsing to https://docs.helm.sh/using_helm/#quickstart-guide should render the quickstart guide but right now I only see the "Using Helm" subsection of the "Using Helm" section.

I wonder if this is a build issue because running hugo on the docs folder renders the section just fine.

At least two of the links in the docs that are meant to take you to the RBAC portions of the docs are broken on the live docs site. In particular:

1. The link to "Tiller and Role-Based Access Control" from this section https://docs.helm.sh/using_helm/#special-note-for-rbac-users
2. The link to "RBAC enabled clusters" from https://docs.helm.sh/using_helm/#easy-in-cluster-installation

I'd fix the links myself, but it's not actually clear to me what's wrong with the first one judging by how other section references work in your docs. It seems likely that they're both trying to reference https://docs.helm.sh/using_helm/#role-based-access-control, though.

Link: https://docs.helm.sh/using_helm/rbac

Referenced from: https://docs.helm.sh/using_helm/#special-note-for-rbac-users

Since Helm 2, the docs site has just shown the latest state of the project docs. Ideally we should restructure things with Helm 3 on the horizon:

• render different versions of the site so there is a clear url structure
  e.g. helm.sh/2.13.1/ and helm.sh/3.1
• clearly indicate what version of docs you're viewing
• i'll create issues for related tasks with the v3 label
  • highlight the Helm 2 > Helm 3 FAQs
  • update the site I.A.
  • new landing page

Example: kubernetes.io

Follow on from #47.

There's an error being thrown, most likely from the scrollspy script in app_init_min.js which checks the page url against the sidebar hrefs...

Uncaught Error: Syntax error, unrecognized expression: ../../using_helm/#quickstart-guide
    at Function.e.error (main.min.js:1)
    at e.tokenize (main.min.js:1)
    at e.select (main.min.js:1)
    at Function.e [as find] (main.min.js:1)
    at Z.fn.init.find (main.min.js:2)
    at Z.fn.init (main.min.js:2)
    at Z (main.min.js:1)
    at HTMLAnchorElement.<anonymous> (app_init.min.js:1)
    at main.min.js:1
    at Function.map (main.min.js:1)

We're currently planning on serving the helm docs as a subdomain on the existing helm.sh site, that is, at docs.helm.sh.

To do so, and hook up CI/CD to do the webpage build/deploy, we'll want to:

• create a docs sub-directory, under which the following will be added:
  • a rootfs folder to hold built html/assets/web page
  • a Dockerfile which will bundle said assets into an image that can be deployed as a Workflow app
  • a Makefile for housing build/deploy targets (such as the one currently used here for helm.sh)

Associated/Infra:

• Cloudflare subdomain addition
• add CI (either a Jenkinsfile or another job written in DSL in the deis/jenkins-jobs repo)

On mobile, the logo and main menu are overlapping, resulting in a messy visual and making it hard to click/tap the menu links.

Thanks @bridgetkromhout for flagging this!

In the docs under the helm "see also" section the links are to anchors with an _ in them. The actual anchors use a - (dash) instead (see example). So, the links don't work.

It would be useful to have CI on every pull request and CD (deployment) when new things land on master. This would enable a better review experience and allow for things to be deployed outside the the Helm team at Microsoft (where this is currently handled).

The CNCF has support for https://www.netlify.com/ which is what k8s uses. It may be an option to investigate.

Side note, breaking the docs out into their own repo was discussed on the last Helm call with support. This may make it easier to handle publishing of docs separate from the site.

Just going through the Table of Contents links here https://helm.sh/docs/chart_best_practices/ the anchors for some links are broken from that TOC - clicking them doesn't take you to the correct section of the page. Looking at the docs in GitHub, it looks like the ones are broken are where the markdown filenames do not match the link text, and I guess whatever is building the HTML docs from the Markdown can’t build the links?

The Following links are broken:
https://helm.sh/docs/chart_best_practices/#conventions
https://helm.sh/docs/chart_best_practices/#requirements
https://helm.sh/docs/chart_best_practices/#labels
https://helm.sh/docs/chart_best_practices/#pods
https://helm.sh/docs/chart_best_practices/#custom_resource_definitions