From 2f634cb8a604598914a0a3e607ba8e0f11f28eac Mon Sep 17 00:00:00 2001 From: Janet Kuo Date: Mon, 29 Aug 2016 11:11:31 -0700 Subject: [PATCH 1/3] Add docs for 3rd-party tools --- docs/user-guide/third-party-tools.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 docs/user-guide/third-party-tools.md diff --git a/docs/user-guide/third-party-tools.md b/docs/user-guide/third-party-tools.md new file mode 100644 index 0000000000..dd54a94181 --- /dev/null +++ b/docs/user-guide/third-party-tools.md @@ -0,0 +1,27 @@ +--- +assignees: +- janetkuo + +--- + +* TOC +{:toc} + +## Helm + +[Kubernetes Helm](https://github.com/kubernetes/helm) is a tool for managing packages of pre-configured +Kubernetes resources, aka Kubernetes charts. + +Use Helm to: + +* Find and use popular software packaged as Kubernetes charts +* Share your own applications as Kubernetes charts +* Create reproducible builds of your Kubernetes applications +* Intelligently manage your Kubernetes manifest files +* Manage releases of Helm packages + +## Kompose + +[`kompose`](https://github.com/skippbox/kompose) is a tool to help users familiar with `docker-compose` +move to Kubernetes. It takes a Docker Compose file and translates it into Kubernetes objects. `kompose` +is a convenient tool to go from local Docker development to managing your application with Kubernetes. From bfc93d17796185adf5623948d76a74f2a1cc18c3 Mon Sep 17 00:00:00 2001 From: Janet Kuo Date: Tue, 27 Sep 2016 16:06:18 -0700 Subject: [PATCH 2/3] Add Tools top nav and move 3rd party doc under it --- _data/globals.yml | 1 + _data/tools.yml | 6 ++++++ _layouts/docwithnav.html | 1 + docs/tools/index.md | 9 +++++++++ docs/{user-guide => tools}/third-party-tools.md | 0 5 files changed, 17 insertions(+) create mode 100644 _data/tools.yml create mode 100644 docs/tools/index.md rename docs/{user-guide => tools}/third-party-tools.md (100%) diff --git a/_data/globals.yml b/_data/globals.yml index c83dae26dd..73978ea750 100644 --- a/_data/globals.yml +++ b/_data/globals.yml @@ -4,5 +4,6 @@ tocs: - tasks - concepts - reference +- tools - samples - support diff --git a/_data/tools.yml b/_data/tools.yml new file mode 100644 index 0000000000..a6c03cdf6f --- /dev/null +++ b/_data/tools.yml @@ -0,0 +1,6 @@ +bigheader: "Tools" +toc: +- title: Tools + path: /docs/tools/ +- title: Third-Party Tools + path: /docs/tools/third-party-tools/ diff --git a/_layouts/docwithnav.html b/_layouts/docwithnav.html index 2432c5b795..c2f74c1bb4 100755 --- a/_layouts/docwithnav.html +++ b/_layouts/docwithnav.html @@ -16,6 +16,7 @@
  • TASKS
  • CONCEPTS
  • REFERENCE
    • +
  • TOOLS
  • SAMPLES
  • SUPPORT
    • diff --git a/docs/tools/index.md b/docs/tools/index.md new file mode 100644 index 0000000000..9f4e57ec76 --- /dev/null +++ b/docs/tools/index.md @@ -0,0 +1,9 @@ +--- +--- + +The Tools section of the Kubernetes documentation is a work in progress + +#### Third-Party Tools + +* [Recommended third-party tools, including Helm and Kompose](/docs/tasks/third-party-tools) + diff --git a/docs/user-guide/third-party-tools.md b/docs/tools/third-party-tools.md similarity index 100% rename from docs/user-guide/third-party-tools.md rename to docs/tools/third-party-tools.md From e44f4a2d5c26e0998e9ab42e86b33f9561df0efc Mon Sep 17 00:00:00 2001 From: Janet Kuo Date: Wed, 5 Oct 2016 14:24:14 -0700 Subject: [PATCH 3/3] Remove third-party page and make one page for all tools --- _data/tools.yml | 2 -- docs/tools/index.md | 37 ++++++++++++++++++++++++++++++--- docs/tools/third-party-tools.md | 27 ------------------------ 3 files changed, 34 insertions(+), 32 deletions(-) delete mode 100644 docs/tools/third-party-tools.md diff --git a/_data/tools.yml b/_data/tools.yml index a6c03cdf6f..8993e091bb 100644 --- a/_data/tools.yml +++ b/_data/tools.yml @@ -2,5 +2,3 @@ bigheader: "Tools" toc: - title: Tools path: /docs/tools/ -- title: Third-Party Tools - path: /docs/tools/third-party-tools/ diff --git a/docs/tools/index.md b/docs/tools/index.md index 9f4e57ec76..31d5fe985e 100644 --- a/docs/tools/index.md +++ b/docs/tools/index.md @@ -1,9 +1,40 @@ --- +assignees: +- janetkuo + --- -The Tools section of the Kubernetes documentation is a work in progress +* TOC +{:toc} -#### Third-Party Tools +## Native Tools -* [Recommended third-party tools, including Helm and Kompose](/docs/tasks/third-party-tools) +### Kubectl +[`kubectl`](docs/user-guide/kubectl/) is the command line tool for Kubernetes. It controls the Kubernetes cluster manager. + +### Dashboard + +[Dashboard](docs/user-guide/ui/), the web-based user interface of Kubernetes, allows you to deploy containerized applications +to a Kubernetes cluster, troubleshoot them, and manage the cluster and its resources itself. + +## Third-Party Tools + +### Helm + +[Kubernetes Helm](https://github.com/kubernetes/helm) is a tool for managing packages of pre-configured +Kubernetes resources, aka Kubernetes charts. + +Use Helm to: + +* Find and use popular software packaged as Kubernetes charts +* Share your own applications as Kubernetes charts +* Create reproducible builds of your Kubernetes applications +* Intelligently manage your Kubernetes manifest files +* Manage releases of Helm packages + +### Kompose + +[`kompose`](https://github.com/skippbox/kompose) is a tool to help users familiar with `docker-compose` +move to Kubernetes. It takes a Docker Compose file and translates it into Kubernetes objects. `kompose` +is a convenient tool to go from local Docker development to managing your application with Kubernetes. diff --git a/docs/tools/third-party-tools.md b/docs/tools/third-party-tools.md deleted file mode 100644 index dd54a94181..0000000000 --- a/docs/tools/third-party-tools.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -assignees: -- janetkuo - ---- - -* TOC -{:toc} - -## Helm - -[Kubernetes Helm](https://github.com/kubernetes/helm) is a tool for managing packages of pre-configured -Kubernetes resources, aka Kubernetes charts. - -Use Helm to: - -* Find and use popular software packaged as Kubernetes charts -* Share your own applications as Kubernetes charts -* Create reproducible builds of your Kubernetes applications -* Intelligently manage your Kubernetes manifest files -* Manage releases of Helm packages - -## Kompose - -[`kompose`](https://github.com/skippbox/kompose) is a tool to help users familiar with `docker-compose` -move to Kubernetes. It takes a Docker Compose file and translates it into Kubernetes objects. `kompose` -is a convenient tool to go from local Docker development to managing your application with Kubernetes.