From f65991f8cfc49db2dc52369890946287f4ec4d44 Mon Sep 17 00:00:00 2001 From: Mitchell Nielsen Date: Thu, 16 Apr 2020 11:21:56 -0400 Subject: [PATCH 1/2] Add docs on common developer tools --- doc/development/index.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/doc/development/index.md b/doc/development/index.md index df5fa6c13b..e359ba60cc 100644 --- a/doc/development/index.md +++ b/doc/development/index.md @@ -2,6 +2,18 @@ Our contribution policies can be found in [CONTRIBUTING.md](https://gitlab.com/gitlab-org/charts/gitlab/tree/master/CONTRIBUTING.md) +## Common developer tools + +Developers working on charts often use the following tools: + +Tool name | Benefits | Example use case | Link(s) +-|-|-|- +`asdf` | Easily switch between versions of your favorite runtimes and CLI tools. | Switching between Helm 2 and Helm 3 binaries. | [GitHub](https://github.com/asdf-vm/asdf) +`kubectx` & `kubens` | Manage and switch between Kubernetes contexts and namespaces. | Setting default namespace per selected cluster context. | [GitHub](https://github.com/ahmetb/kubectx) +`k3s` | Lightweight Kubernetes installation (<40MB). | Quick and reliable local chart testing. | [Homepage](https://k3s.io) +`k9s` | Greatly reduced typing of `kubectl` commands. | Navigate and manage cluster resources quickly. | [GitHub](https://github.com/derailed/k9s) +`stern` | Easily follow logs from multiple pods. | See logs from a set of GitLab pods together. | [GitHub](https://github.com/wercker/stern) + ## Versioning and Release Details on the version scheme, branching and tags can be found in [release document](release.md). -- GitLab From 3bcc1e571dd109bb27c64d4f1361f92689285a45 Mon Sep 17 00:00:00 2001 From: Mitchell Nielsen Date: Sat, 18 Apr 2020 11:39:30 -0400 Subject: [PATCH 2/2] Rename page header to Development Guide --- doc/development/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/development/index.md b/doc/development/index.md index e359ba60cc..08a9022c2f 100644 --- a/doc/development/index.md +++ b/doc/development/index.md @@ -1,4 +1,4 @@ -# Development styleguide +# Development Guide Our contribution policies can be found in [CONTRIBUTING.md](https://gitlab.com/gitlab-org/charts/gitlab/tree/master/CONTRIBUTING.md) -- GitLab