Contributing (argoproj#116)

.github/pull_request_template.md

@@ -1,18 +1,5 @@
-* [ ] I have update the chart version in `Chart.yaml` following Semantic Versioning.
-* [ ] All new values are backwards compatible and/or have sensible default.
-* [ ] I have installed the chart myself and it works.
-
-E.g. for Argo Workflows:
-
-```
-helm install charts/argo
-argo version
-```
+Checklist:
 
-E.g. for Argo CD:
-
-```
-helm install charts/argo-cd --namespace argocd
-kubectl port-forward svc/argocd-server -n argocd 8080:443 &
-argocd version
-```
+* [ ] I have update the chart version in `Chart.yaml` following Semantic Versioning.
+* [ ] Any new values are backwards compatible and/or have sensible default.
+* [ ] I have followed the testing instructions in the [contributing guide](https://github.com/argoproj/argo-helm/blob/master/CONTRIBUTING.md).

CONTRIBUTING.md

@@ -0,0 +1,61 @@
+# Contributing
+
+Argo Helm is a collection of **community maintained** charts. Therefore we rely on you to test your changes sufficiently.
+
+## Testing Argo Workflows Changes
+
+Minimally:
+
+```
+helm install charts/argo -n argo
+argo version
+```
+
+Follow this instructions for running a hello world workflow.
+
+## Testing Argo CD Changes
+
+Clean-up:
+
+```
+helm delete argo-cd --purge
+kubectl delete crd -l app.kubernetes.io/part-of=argo-cd
+```
+
+Minimally:
+
+```
+helm install charts/argo-cd --namespace argocd -n argo-cd
+kubectl port-forward svc/argocd-server -n argocd 8080:443
+```
+
+In a new terminal:
+
+```
+argocd version
+# reset password to 'Password1!'
+kubectl -n argocd patch secret argocd-secret \
+  -p '{"stringData": {
+    "admin.password": "$2a$10$hDj12Tw9xVmvybSahN1Y0.f9DZixxN8oybyA32Uy/eqWklFU4Mo8O",
+    "admin.passwordMtime": "'$(date +%FT%T%Z)'"
+  }}'
+argocd login localhost:8080 --username admin --password 'Password1!'
+```
+
+Create and sync app:
+
+```
+argocd app create guestbook --dest-namespace default --dest-server https://kubernetes.default.svc --path guestbook --project default --repo https://github.com/argoproj/argocd-example-apps.git
+argocd app sync guestbook
+```
+
+## Publishing Changes
+
+To push changes use following script:
+
+```
+GIT_PUSH=true ./scripts/publish.sh
+```
+
+Script generates tar file for each chart in `charts` directory and push changes to `gh-pages` branch.
+Write access to https://github.com/argoproj/argo-helm.git is required to publish changes.

OWNERS

@@ -1,8 +1,9 @@
 owners:
+- alexec
 - alexmt
 - jessesuen
 
 approvers:
+- alexec
 - alexmt
 - jessesuen
-- merenbach

README.md

@@ -1,19 +1,7 @@
 # Argo Helm Charts
 
-Repository contains helm charts for http://argoproj.io/ projects. Helm charts repository is hosted using Github pages 
-and can be added using following command:
+Argo Helm is a collection of **community maintained** charts for http://argoproj.io/ projects. the charts can be added using following command:
 
 ```
 helm repo add argo https://argoproj.github.io/argo-helm
 ```
-
-## Publishing changes
-
-To push changes use following script:
-
-```
-GIT_PUSH=true ./scripts/publish.sh
-```
-
-Script generates tar file for each chart in `charts` directory and push changes to `gh-pages` branch.
-Write access to https://github.com/argoproj/argo-helm.git is required to publish changes.

charts/argo-cd/README.md

@@ -1,6 +1,6 @@
-# argo-cd
+# Argo CD Chart
 
-This chart installs [argo-cd](https://argoproj.github.io/argo-cd/), a declarative, GitOps continuous delivery tool for Kubernetes.
+This is a **community maintained** chart. This chart installs [argo-cd](https://argoproj.github.io/argo-cd/), a declarative, GitOps continuous delivery tool for Kubernetes.
 
 The default installation is intended to be similar to the provided ArgoCD [releases](https://github.com/argoproj/argo-cd/releases).
 

charts/argo-ci/README.md

@@ -0,0 +1,3 @@
+# Argo CI Chart
+
+This is a **community maintained** chart.

charts/argo-events/README.md

@@ -1,5 +1,6 @@
-# Argo-Events Helm Chart
-This helm chart installs the [argo-events](https://github.com/argoproj/argo-events) application. This application comes packaged with:
+# Argo-Events Chart
+
+This is a **community maintained** chart. It installs the [argo-events](https://github.com/argoproj/argo-events) application. This application comes packaged with:
 - Sensor Custom Resource Definition
 - Gateway Custom Resource Definition
 - Sensor Controller Deployment

charts/argo/README.md

@@ -1,5 +1,6 @@
-## Argo Chart
-This chart is used to set up argo and it's needed dependencies through one command. This is used in conjunction with [helm](https://github.com/kubernetes/helm).
+## Argo Workflows Chart
+
+This is a **community maintained** chart. It is used to set up argo and it's needed dependencies through one command. This is used in conjunction with [helm](https://github.com/kubernetes/helm).
 
 If you want your deployment of this helm chart to most closely match the [argo CLI](https://github.com/argoproj/argo), you should deploy it in the `kube-system` namespace.
 
@@ -24,4 +25,3 @@ Fields to note:
 * `controller.workflowNamespaces`: This is a list of namespaces where workflows will be ran
 * `minio.install`: If this is true, we'll install [minio](https://github.com/kubernetes/charts/tree/master/stable/minio) and build out the artifactRepository section in workflow controller config map.
 * `artifactRepository.s3.accessKeySecret` and `artifactRepository.s3.secretKeySecret` These by default link to minio default credentials stored in the secret deployed by the minio chart.
-