From 2a82e6cbe6edef991db97350dc77708b1a1cbc4a Mon Sep 17 00:00:00 2001 From: Matthew Fisher Date: Tue, 5 Mar 2019 11:57:39 -0800 Subject: [PATCH] docs: s,kubernetes/helm,helm/helm,g (#5404) Signed-off-by: Matthew Fisher --- README.md | 44 +++++++++---------- cmd/helm/testdata/testcharts/empty/Chart.yaml | 2 +- docs/chart_repository_sync_example.md | 2 +- docs/developers.md | 2 +- docs/glossary.md | 2 +- docs/install.md | 6 +-- docs/release_checklist.md | 6 +-- pkg/action/install.go | 2 +- 8 files changed, 31 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index aeb501d90..2239f8e50 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,15 @@ -# Kubernetes Helm +# Helm -[![CircleCI](https://circleci.com/gh/kubernetes/helm.svg?style=svg)](https://circleci.com/gh/kubernetes/helm) -[![Go Report Card](https://goreportcard.com/badge/github.com/kubernetes/helm)](https://goreportcard.com/report/github.com/kubernetes/helm) -[![GoDoc](https://godoc.org/github.com/kubernetes/helm?status.svg)](https://godoc.org/github.com/kubernetes/helm) +[![CircleCI](https://circleci.com/gh/helm/helm.svg?style=shield)](https://circleci.com/gh/helm/helm) +[![Go Report Card](https://goreportcard.com/badge/github.com/helm/helm)](https://goreportcard.com/report/github.com/helm/helm) +[![GoDoc](https://godoc.org/k8s.io/helm?status.svg)](https://godoc.org/k8s.io/helm) -Helm is a tool for managing Kubernetes charts. Charts are packages of -pre-configured Kubernetes resources. +Helm is a tool for managing Charts. Charts are packages of pre-configured Kubernetes resources. Use Helm to: -- Find and use [popular software packaged as Kubernetes charts](https://github.com/helm/charts) -- Share your own applications as Kubernetes charts +- Find and use [popular software packaged as Helm Charts](https://github.com/helm/charts) to run in Kubernetes +- Share your own applications as Helm Charts - Create reproducible builds of your Kubernetes applications - Intelligently manage your Kubernetes manifest files - Manage releases of Helm packages @@ -31,19 +30,17 @@ Think of it like apt/yum/homebrew for Kubernetes. ## Install -Binary downloads of the Helm client can be found at the following links: -- [OSX](https://kubernetes-helm.storage.googleapis.com/helm-v2.8.2-darwin-amd64.tar.gz) -- [Linux](https://kubernetes-helm.storage.googleapis.com/helm-v2.8.2-linux-amd64.tar.gz) -- [Linux 32-bit](https://kubernetes-helm.storage.googleapis.com/helm-v2.8.2-linux-386.tar.gz) -- [Windows](https://kubernetes-helm.storage.googleapis.com/helm-v2.8.2-windows-amd64.tar.gz) +Binary downloads of the Helm client can be found on [the Releases page](https://github.com/helm/helm/releases/latest). Unpack the `helm` binary and add it to your PATH and you are good to go! If you want to use a package manager: -- macOS/[homebrew](https://brew.sh/) users can use `brew install kubernetes-helm`. -- Windows/[chocolatey](https://chocolatey.org/) users can use `choco install kubernetes-helm`. +- [Homebrew](https://brew.sh/) users can use `brew install kubernetes-helm`. +- [Chocolatey](https://chocolatey.org/) users can use `choco install kubernetes-helm`. +- [Scoop](https://scoop.sh/) users can use `scoop install helm`. +- [GoFish](https://gofi.sh/) users can use `gofish install helm`. To rapidly get Helm up and running, start with the [Quick Start Guide](https://docs.helm.sh/using_helm/#quickstart-guide). @@ -62,15 +59,14 @@ The [Helm roadmap uses Github milestones](https://github.com/helm/helm/milestone You can reach the Helm community and developers via the following channels: -- [Kubernetes Slack](http://slack.k8s.io): - - #helm-users - - #helm-dev - - #charts -- Mailing Lists: - - [Helm Mailing List](https://lists.cncf.io/g/cncf-kubernetes-helm) - - [Kubernetes SIG Apps Mailing List](https://groups.google.com/forum/#!forum/kubernetes-sig-apps) -- Developer Call: Thursdays at 9:30-10:00 Pacific. [https://zoom.us/j/4526666954](https://zoom.us/j/4526666954) +- [Kubernetes Slack](https://kubernetes.slack.com): + - [#helm-users](https://kubernetes.slack.com/messages/helm-users) + - [#helm-dev](https://kubernetes.slack.com/messages/helm-dev) + - [#charts](https://kubernetes.slack.com/messages/charts) +- Mailing List: + - [Helm Mailing List](https://lists.cncf.io/g/cncf-helm) +- Developer Call: Thursdays at 9:30-10:00 Pacific. [https://zoom.us/j/696660622](https://zoom.us/j/696660622) ### Code of conduct -Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md). +Participation in the Helm community is governed by the [Code of Conduct](code-of-conduct.md). diff --git a/cmd/helm/testdata/testcharts/empty/Chart.yaml b/cmd/helm/testdata/testcharts/empty/Chart.yaml index 0e97f247c..a87f4201f 100644 --- a/cmd/helm/testdata/testcharts/empty/Chart.yaml +++ b/cmd/helm/testdata/testcharts/empty/Chart.yaml @@ -2,5 +2,5 @@ description: Empty testing chart home: https://k8s.io/helm name: empty sources: -- https://github.com/kubernetes/helm +- https://github.com/helm/helm version: 0.1.0 diff --git a/docs/chart_repository_sync_example.md b/docs/chart_repository_sync_example.md index de140c636..b98f98e8f 100644 --- a/docs/chart_repository_sync_example.md +++ b/docs/chart_repository_sync_example.md @@ -29,7 +29,7 @@ Upload the contents of the directory to your GCS bucket by running `scripts/sync For example: ```console $ pwd -/Users/funuser/go/src/github.com/kubernetes/helm +/Users/me/code/go/src/k8s.io/helm $ scripts/sync-repo.sh fantastic-charts/ fantastic-charts Getting ready to sync your local directory (fantastic-charts/) to a remote repository at gs://fantastic-charts Verifying Prerequisites.... diff --git a/docs/developers.md b/docs/developers.md index 622834686..86f241c6f 100644 --- a/docs/developers.md +++ b/docs/developers.md @@ -99,7 +99,7 @@ We accept changes to the code via GitHub Pull Requests (PRs). One workflow for doing this is as follows: 1. Go to your `$GOPATH/src/k8s.io` directory and `git clone` the - `github.com/kubernetes/helm` repository. + `github.com/helm/helm` repository. 2. Fork that repository into your GitHub account 3. Add your repository as a remote for `$GOPATH/src/k8s.io/helm` 4. Create a new working branch (`git checkout -b feat/my-feature`) and diff --git a/docs/glossary.md b/docs/glossary.md index b40ad5aa0..c95e8561e 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -133,7 +133,7 @@ install, upgrade, and rollback. ## Helm Library It interacts directly with the Kubernetes API server to install, - upgrade, query, and remove Kubernetes resources. +upgrade, query, and remove Kubernetes resources. ## Repository (Repo, Chart Repository) diff --git a/docs/install.md b/docs/install.md index bf181d64c..ad7b1b111 100755 --- a/docs/install.md +++ b/docs/install.md @@ -45,18 +45,18 @@ choco install kubernetes-helm ## From Script Helm now has an installer script that will automatically grab the latest version -of Helm and [install it locally](https://raw.githubusercontent.com/kubernetes/helm/master/scripts/get). +of Helm and [install it locally](https://raw.githubusercontent.com/helm/helm/master/scripts/get). You can fetch that script, and then execute it locally. It's well documented so that you can read through it and understand what it is doing before you run it. ``` -$ curl https://raw.githubusercontent.com/kubernetes/helm/master/scripts/get > get_helm.sh +$ curl https://raw.githubusercontent.com/helm/helm/master/scripts/get > get_helm.sh $ chmod 700 get_helm.sh $ ./get_helm.sh ``` -Yes, you can `curl https://raw.githubusercontent.com/kubernetes/helm/master/scripts/get | bash` that if you want to live on the edge. +Yes, you can `curl https://raw.githubusercontent.com/helm/helm/master/scripts/get | bash` that if you want to live on the edge. ### From Canary Builds diff --git a/docs/release_checklist.md b/docs/release_checklist.md index ec043697f..8d3b78b23 100644 --- a/docs/release_checklist.md +++ b/docs/release_checklist.md @@ -17,7 +17,7 @@ It is important to note that this document assumes that the git remote in your r If you don't have an upstream remote, you can add one easily using something like: ```shell -git remote add upstream git@github.com:kubernetes/helm.git +git remote add upstream git@github.com:helm/helm.git ``` In this doc, we are going to reference a few environment variables as well, which you may want to set for convenience. For major/minor releases, use the following: @@ -134,7 +134,7 @@ In order for others to start testing, we can now push the release branch upstrea git push upstream $RELEASE_BRANCH_NAME ``` -Make sure to check [helm on CircleCI](https://circleci.com/gh/kubernetes/helm) and make sure the release passed CI before proceeding. +Make sure to check [helm on CircleCI](https://circleci.com/gh/helm/helm) and make sure the release passed CI before proceeding. If anyone is available, let others peer-review the branch before continuing to ensure that all the proper changes have been made and all of the commits for the release are there. @@ -234,7 +234,7 @@ Download Helm X.Y. The common platform binaries are here: - [Linux](https://storage.googleapis.com/kubernetes-helm/helm-vX.Y.Z-linux-amd64.tar.gz) - [Windows](https://storage.googleapis.com/kubernetes-helm/helm-vX.Y.Z-windows-amd64.tar.gz) -The [Quickstart Guide](https://docs.helm.sh/using_helm/#quickstart-guide) will get you going from there. For **upgrade instructions** or detailed installation notes, check the [install guide](https://docs.helm.sh/using_helm/#installing-helm). You can also use a [script to install](https://raw.githubusercontent.com/kubernetes/helm/master/scripts/get) on any system with `bash`. +The [Quickstart Guide](https://docs.helm.sh/using_helm/#quickstart-guide) will get you going from there. For **upgrade instructions** or detailed installation notes, check the [install guide](https://docs.helm.sh/using_helm/#installing-helm). You can also use a [script to install](https://raw.githubusercontent.com/helm/helm/master/scripts/get) on any system with `bash`. ## What's Next diff --git a/pkg/action/install.go b/pkg/action/install.go index e2ddee64a..4fac26ae5 100644 --- a/pkg/action/install.go +++ b/pkg/action/install.go @@ -40,7 +40,7 @@ import ( // // As of Kubernetes 1.4, the max limit on a name is 63 chars. We reserve 10 for // charts to add data. Effectively, that gives us 53 chars. -// See https://github.com/kubernetes/helm/issues/1528 +// See https://github.com/helm/helm/issues/1528 const releaseNameMaxLen = 53 // NOTESFILE_SUFFIX that we want to treat special. It goes through the templating engine