From 3ed37d45c1ef57dc4630f95c85b5a8fd0bfb583f Mon Sep 17 00:00:00 2001 From: Mitchell Nielsen Date: Wed, 15 Apr 2020 11:22:34 -0400 Subject: [PATCH 1/4] Add table for 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..ff30381d40 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 87fb39c16fe1c5466fa000dc7f4016e4a29ea6e4 Mon Sep 17 00:00:00 2001 From: Mitchell Nielsen Date: Wed, 15 Apr 2020 12:01:22 -0400 Subject: [PATCH 2/4] Add proper name capitalization --- doc/development/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/development/index.md b/doc/development/index.md index ff30381d40..e359ba60cc 100644 --- a/doc/development/index.md +++ b/doc/development/index.md @@ -8,11 +8,11 @@ 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) +`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) +`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 -- GitLab From 7b4cd4a05968d4e9c71673647535630fb1ab74e4 Mon Sep 17 00:00:00 2001 From: Mitchell Nielsen Date: Wed, 15 Apr 2020 12:01:22 -0400 Subject: [PATCH 3/4] Add proper name capitalization --- changelogs/unreleased/document-developer-tools.yml | 5 +++++ doc/development/index.md | 8 ++++---- 2 files changed, 9 insertions(+), 4 deletions(-) create mode 100644 changelogs/unreleased/document-developer-tools.yml diff --git a/changelogs/unreleased/document-developer-tools.yml b/changelogs/unreleased/document-developer-tools.yml new file mode 100644 index 0000000000..4b2d106545 --- /dev/null +++ b/changelogs/unreleased/document-developer-tools.yml @@ -0,0 +1,5 @@ +--- +title: Document developer tools +merge_request: +author: +type: other diff --git a/doc/development/index.md b/doc/development/index.md index ff30381d40..e359ba60cc 100644 --- a/doc/development/index.md +++ b/doc/development/index.md @@ -8,11 +8,11 @@ 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) +`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) +`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 -- GitLab From 3df9ed1c1813b99b2903346b69e19a7fd2339d81 Mon Sep 17 00:00:00 2001 From: Mitchell Nielsen Date: Wed, 15 Apr 2020 12:06:32 -0400 Subject: [PATCH 4/4] Rename and fill in changelog --- ...nt-developer-tools.yml => 1285-document-developer-tools.yml} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename changelogs/unreleased/{document-developer-tools.yml => 1285-document-developer-tools.yml} (73%) diff --git a/changelogs/unreleased/document-developer-tools.yml b/changelogs/unreleased/1285-document-developer-tools.yml similarity index 73% rename from changelogs/unreleased/document-developer-tools.yml rename to changelogs/unreleased/1285-document-developer-tools.yml index 4b2d106545..0eed1d974a 100644 --- a/changelogs/unreleased/document-developer-tools.yml +++ b/changelogs/unreleased/1285-document-developer-tools.yml @@ -1,5 +1,5 @@ --- title: Document developer tools -merge_request: +merge_request: 1285 author: type: other -- GitLab