Refactored 'Other Guides' and applied redirects. (kubeflow#1064)

numerology · Aug 12, 2019 · 85ba5bb · 85ba5bb
1 parent cf7b9f3
commit 85ba5bb
Show file tree

Hide file tree

Showing 20 changed files with 39 additions and 20 deletions.
diff --git a/content/_redirects b/content/_redirects
@@ -77,5 +77,18 @@ docs/started/requirements/                    /docs/started/getting-started/
 /docs/components/pytorchserving                /docs/components/serving/pytorchserving
 /docs/components/tfserving_new                 /docs/components/serving/tfserving_new
 
-# Restructured the getting-started guide for existing Kubernetes.
+# Restructured the getting-started and other-guides sections.
 /docs/started/getting-started-k8s/             /docs/started/k8s/
+/docs/started/getting-started-minikf/          /docs/other-guides/virtual-dev/getting-started-minikf/
+/docs/started/getting-started-minikube/        /docs/other-guides/virtual-dev/getting-started-minikube/
+/docs/started/getting-started-multipass/       /docs/other-guides/virtual-dev/getting-started-multipass/
+/docs/started/getting-started-aws/             /docs/started/cloud/getting-started-aws/
+/docs/started/getting-started-azure/           /docs/started/cloud/getting-started-azure/
+/docs/started/getting-started-gke/             /docs/started/cloud/getting-started-gke/
+/docs/started/getting-started-icp/             /docs/started/cloud/getting-started-icp/
+
+
+/docs/other-guides/job-scheduling/             /docs/use-cases/job-scheduling/
+/docs/other-guides/upgrade/                    /docs/upgrading/upgrade/
+
+/docs/use-cases/kubeflow-on-multinode-cluster/ /docs/other-guides/kubeflow-on-multinode-cluster/
diff --git a/content/docs/components/training/tftraining.md b/content/docs/components/training/tftraining.md
@@ -682,4 +682,4 @@ Events:
 ## More information
 
 * Explore the [TFJob reference documentation](/docs/reference#tfjob).
-* See how to [run a job with gang-scheduling](/docs/other-guides/job-scheduling).
+* See how to [run a job with gang-scheduling](/docs/use-cases/job-scheduling).
diff --git a/content/docs/gke/deploy/deploy-cli.md b/content/docs/gke/deploy/deploy-cli.md
@@ -224,7 +224,7 @@ The three service accounts are:
   using the CLI.
 * See how to [customize](/docs/gke/customizing-gke) your Kubeflow 
   deployment.
-* See how to [upgrade Kubeflow](/docs/other-guides/upgrade/) and how to 
+* See how to [upgrade Kubeflow](/docs/upgrading/upgrade/) and how to 
   [upgrade or reinstall a Kubeflow Pipelines 
   deployment](/docs/pipelines/upgrade/).
 * [Troubleshoot](/docs/gke/troubleshooting-gke) any issues you may

diff --git a/content/docs/gke/deploy/deploy-ui.md b/content/docs/gke/deploy/deploy-ui.md
@@ -146,7 +146,7 @@ service.
    or the [GCP Console](/docs/gke/deploy/delete-ui).
 * See how to [customize](/docs/gke/customizing-gke) your Kubeflow 
   deployment.
-* See how to [upgrade Kubeflow](/docs/other-guides/upgrade/) and how to 
+* See how to [upgrade Kubeflow](/docs/upgrading/upgrade/) and how to 
   [upgrade or reinstall a Kubeflow Pipelines 
   deployment](/docs/pipelines/upgrade/).
 * [Troubleshoot](/docs/gke/troubleshooting-gke) any issues you may

diff --git a/content/docs/notebooks/troubleshoot.md b/content/docs/notebooks/troubleshoot.md
@@ -8,7 +8,7 @@ weight = 50
 
 First, make sure that PVCs are bounded when using Jupter notebooks. This should
 not be a problem when using managed Kuberenetes. But if you are using Kubernetes
-on-prem, check out the guide to [Kubeflow on-prem in a multi-node Kubernetes cluster](/docs/use-cases/kubeflow-on-multinode-cluster/) if you are running Kubeflow in multi-node on-prem environment. Otherwise, look at the [Pods stuck in Pending State](/docs/other-guides/troubleshooting/#pods-stuck-in-pending-state) guide to troubleshoot this problem.
+on-prem, check out the guide to [Kubeflow on-prem in a multi-node Kubernetes cluster](/docs/other-guides/kubeflow-on-multinode-cluster/) if you are running Kubeflow in multi-node on-prem environment. Otherwise, look at the [Pods stuck in Pending State](/docs/other-guides/troubleshooting/#pods-stuck-in-pending-state) guide to troubleshoot this problem.
 
 ## Check the status of notebooks
 

diff --git a/content/docs/other-guides/_index.md b/content/docs/other-guides/_index.md
@@ -1,5 +1,5 @@
 +++
-title = "Other Guides"
-description = "Various instructions on how to use Kubeflow"
+title = "Further Setup and Troubleshooting"
+description = "Various guides to setting up and troubleshooting your Kubeflow deployment"
 weight = 90
 +++
diff --git a/content/docs/other-guides/accessing-uis.md b/content/docs/other-guides/accessing-uis.md
@@ -1,7 +1,7 @@
 +++
 title = "Accessing Kubeflow UIs"
 description = "How to access the Kubeflow web UIs"
-weight = 15
+weight = 1
 +++
 
 Kubeflow includes a number of web user interfaces (UIs). This document provides

diff --git a/...se-cases/kubeflow-on-multinode-cluster.md → ...r-guides/kubeflow-on-multinode-cluster.md b/...se-cases/kubeflow-on-multinode-cluster.md → ...r-guides/kubeflow-on-multinode-cluster.md
diff --git a/content/docs/other-guides/troubleshooting.md b/content/docs/other-guides/troubleshooting.md
@@ -1,7 +1,7 @@
 +++
 title = "Troubleshooting"
 description = "Finding and fixing problems in your Kubeflow deployment"
-weight = 20
+weight = 100
 +++
 
 

diff --git a/content/docs/other-guides/usage-reporting.md b/content/docs/other-guides/usage-reporting.md
@@ -1,5 +1,6 @@
 +++
 title = "Usage Reporting"
+description = "Opting in or out of anonymous usage data reported from Kubeflow"
 weight = 40
 +++
 

diff --git a/content/docs/reference/virtual-dev/_index.md → ...t/docs/other-guides/virtual-dev/_index.md b/content/docs/reference/virtual-dev/_index.md → ...t/docs/other-guides/virtual-dev/_index.md
diff --git a/...nce/virtual-dev/getting-started-minikf.md → ...des/virtual-dev/getting-started-minikf.md b/...nce/virtual-dev/getting-started-minikf.md → ...des/virtual-dev/getting-started-minikf.md
diff --git a/...e/virtual-dev/getting-started-minikube.md → ...s/virtual-dev/getting-started-minikube.md b/...e/virtual-dev/getting-started-minikube.md → ...s/virtual-dev/getting-started-minikube.md
diff --git a/.../virtual-dev/getting-started-multipass.md → .../virtual-dev/getting-started-multipass.md b/.../virtual-dev/getting-started-multipass.md → .../virtual-dev/getting-started-multipass.md
diff --git a/content/docs/started/workstation/getting-started-linux.md b/content/docs/started/workstation/getting-started-linux.md
@@ -44,7 +44,7 @@ The only following applications are required to use MiniKF:
 - Install [Virtual Box](https://www.virtualbox.org/wiki/Downloads)
 
 The full set of instructions are available on the
-[MiniKF getting started](/docs/reference/virtual-dev/getting-started-minikf/) page.
+[MiniKF getting started](/docs/other-guides/virtual-dev/getting-started-minikf/) page.
 
 ### Linux Appliance
 
@@ -54,7 +54,7 @@ of flexibility. You only need to install a single application to follow this pat
 
 - Install [Multipass](https://multipass.run/#install)
 
-The instructions on [Multipass and MicroK8s getting started](/docs/reference/virtual-dev/getting-started-multipass/)
+The instructions on [Multipass and MicroK8s getting started](/docs/other-guides/virtual-dev/getting-started-multipass/)
 page will complete this path.
 
 ### Kubernetes Appliance
@@ -75,4 +75,4 @@ appliance, you only need to install a couple of applications, and then install K
 - Install [Minikube](https://github.com/kubernetes/minikube/releases)
 
 The full set of instructions are available on the
-[Minikube getting started](/docs/reference/virtual-dev/getting-started-minikube/) page.
+[Minikube getting started](/docs/other-guides/virtual-dev/getting-started-minikube/) page.
diff --git a/content/docs/started/workstation/getting-started-macos.md b/content/docs/started/workstation/getting-started-macos.md
@@ -28,7 +28,7 @@ The only following applications are required to use MiniKF:
 - Install [Virtual Box](https://www.virtualbox.org/wiki/Downloads)
 
 The full set of instructions are available on the
-[MiniKF getting started](/docs/reference/virtual-dev/getting-started-minikf/) page.
+[MiniKF getting started](/docs/other-guides/virtual-dev/getting-started-minikf/) page.
 
 ## Linux Appliance
 
@@ -38,7 +38,7 @@ of flexibility. You only need to install a single application to follow this pat
 
 - Install [Multipass](https://multipass.run/#install)
 
-The instructions on [Multipass and MicroK8s getting started](/docs/reference/virtual-dev/getting-started-multipass/)
+The instructions on [Multipass and MicroK8s getting started](/docs/other-guides/virtual-dev/getting-started-multipass/)
 page will complete this path.
 
 ## Kubernetes Appliance
@@ -59,4 +59,4 @@ appliance, you only need to install a couple of applications, and then install K
 - Install [Minikube](https://github.com/kubernetes/minikube/releases)
 
 The full set of instructions are available on the
-[Minikube getting started](/docs/reference/virtual-dev/getting-started-minikube/) page.
+[Minikube getting started](/docs/other-guides/virtual-dev/getting-started-minikube/) page.
diff --git a/content/docs/started/workstation/getting-started-windows.md b/content/docs/started/workstation/getting-started-windows.md
@@ -32,7 +32,7 @@ The following applications are required to use MiniKF:
 - Install [Virtual Box](https://www.virtualbox.org/wiki/Downloads)
 
 The full set of instructions are available on the
-[MiniKF getting started](/docs/reference/virtual-dev/getting-started-minikf/) page.
+[MiniKF getting started](/docs/other-guides/virtual-dev/getting-started-minikf/) page.
 
 ## Linux Appliance
 
@@ -42,7 +42,7 @@ of flexibility. You only need to install a single application to follow this pat
 
 - Install [Multipass](https://multipass.run/#install)
 
-The instructions on [Multipass and MicroK8s getting started](/docs/reference/virtual-dev/getting-started-multipass/)
+The instructions on [Multipass and MicroK8s getting started](/docs/other-guides/virtual-dev/getting-started-multipass/)
 page will complete this path.
 
 ## Kubernetes Appliance
@@ -63,4 +63,4 @@ appliance, you only need to install a couple of applications, and then install K
 - Install [Minikube](https://github.com/kubernetes/minikube/releases)
 
 The full set of instructions are available on the
-[Minikube getting started](/docs/reference/virtual-dev/getting-started-minikube/) page.
+[Minikube getting started](/docs/other-guides/virtual-dev/getting-started-minikube/) page.
diff --git a/content/docs/upgrading/_index.md b/content/docs/upgrading/_index.md
@@ -0,0 +1,5 @@
++++
+title = "Upgrading Kubeflow"
+description = "Guides to upgrading your Kubeflow deployment"
+weight = 100
++++
diff --git a/content/docs/other-guides/upgrade.md → content/docs/upgrading/upgrade.md b/content/docs/other-guides/upgrade.md → content/docs/upgrading/upgrade.md
@@ -1,6 +1,6 @@
 +++
-title = "Upgrading Kubeflow Deployments"
-description = "Upgrading your Kubeflow deployment"
+title = "Upgrading a Kubeflow Deployment"
+description = "Upgrading your deployment to a later version of Kubeflow"
 weight = 30
 +++
 

diff --git a/content/docs/other-guides/job-scheduling.md → content/docs/use-cases/job-scheduling.md b/content/docs/other-guides/job-scheduling.md → content/docs/use-cases/job-scheduling.md