From e5f5f85991c88bc6324d2d888303559668f8e416 Mon Sep 17 00:00:00 2001 From: Sarah Maddox Date: Mon, 12 Aug 2019 14:57:09 +1000 Subject: [PATCH] Refactored 'Other Guides' and applied redirects. --- content/_redirects | 15 ++++++++++++++- content/docs/components/training/tftraining.md | 2 +- content/docs/gke/deploy/deploy-cli.md | 2 +- content/docs/gke/deploy/deploy-ui.md | 2 +- content/docs/notebooks/troubleshoot.md | 2 +- content/docs/other-guides/_index.md | 4 ++-- content/docs/other-guides/accessing-uis.md | 2 +- .../kubeflow-on-multinode-cluster.md | 0 content/docs/other-guides/troubleshooting.md | 2 +- content/docs/other-guides/usage-reporting.md | 1 + .../virtual-dev/_index.md | 0 .../virtual-dev/getting-started-minikf.md | 0 .../virtual-dev/getting-started-minikube.md | 0 .../virtual-dev/getting-started-multipass.md | 0 .../started/workstation/getting-started-linux.md | 6 +++--- .../started/workstation/getting-started-macos.md | 6 +++--- .../workstation/getting-started-windows.md | 6 +++--- content/docs/upgrading/_index.md | 5 +++++ .../docs/{other-guides => upgrading}/upgrade.md | 4 ++-- .../{other-guides => use-cases}/job-scheduling.md | 0 20 files changed, 39 insertions(+), 20 deletions(-) rename content/docs/{use-cases => other-guides}/kubeflow-on-multinode-cluster.md (100%) rename content/docs/{reference => other-guides}/virtual-dev/_index.md (100%) rename content/docs/{reference => other-guides}/virtual-dev/getting-started-minikf.md (100%) rename content/docs/{reference => other-guides}/virtual-dev/getting-started-minikube.md (100%) rename content/docs/{reference => other-guides}/virtual-dev/getting-started-multipass.md (100%) create mode 100644 content/docs/upgrading/_index.md rename content/docs/{other-guides => upgrading}/upgrade.md (92%) rename content/docs/{other-guides => use-cases}/job-scheduling.md (100%) diff --git a/content/_redirects b/content/_redirects index 2a96735348..0874b0776c 100644 --- 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/ \ No newline at end of file diff --git a/content/docs/components/training/tftraining.md b/content/docs/components/training/tftraining.md index b703ea292f..f1e522071d 100644 --- 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 index 257f75866c..5463994478 100644 --- 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 index 7aa1da81db..1fe199239f 100644 --- 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 index 235dbd2141..c5d890298c 100644 --- 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 index 313d440898..508ff8153d 100644 --- 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 index abafabce12..54131209a0 100644 --- 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/content/docs/use-cases/kubeflow-on-multinode-cluster.md b/content/docs/other-guides/kubeflow-on-multinode-cluster.md similarity index 100% rename from content/docs/use-cases/kubeflow-on-multinode-cluster.md rename to content/docs/other-guides/kubeflow-on-multinode-cluster.md diff --git a/content/docs/other-guides/troubleshooting.md b/content/docs/other-guides/troubleshooting.md index 30d896c09b..eca0056b39 100644 --- 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 index fc6aad247f..234b288ff2 100644 --- 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 b/content/docs/other-guides/virtual-dev/_index.md similarity index 100% rename from content/docs/reference/virtual-dev/_index.md rename to content/docs/other-guides/virtual-dev/_index.md diff --git a/content/docs/reference/virtual-dev/getting-started-minikf.md b/content/docs/other-guides/virtual-dev/getting-started-minikf.md similarity index 100% rename from content/docs/reference/virtual-dev/getting-started-minikf.md rename to content/docs/other-guides/virtual-dev/getting-started-minikf.md diff --git a/content/docs/reference/virtual-dev/getting-started-minikube.md b/content/docs/other-guides/virtual-dev/getting-started-minikube.md similarity index 100% rename from content/docs/reference/virtual-dev/getting-started-minikube.md rename to content/docs/other-guides/virtual-dev/getting-started-minikube.md diff --git a/content/docs/reference/virtual-dev/getting-started-multipass.md b/content/docs/other-guides/virtual-dev/getting-started-multipass.md similarity index 100% rename from content/docs/reference/virtual-dev/getting-started-multipass.md rename to content/docs/other-guides/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 index ec47c008e6..f4aa725594 100644 --- 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 index 5e9e9b5222..34624def40 100644 --- 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 index 90a0dff5b4..7d7ace0efd 100644 --- 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 new file mode 100644 index 0000000000..c463dba0b4 --- /dev/null +++ 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 b/content/docs/upgrading/upgrade.md similarity index 92% rename from content/docs/other-guides/upgrade.md rename to content/docs/upgrading/upgrade.md index e604a59cb0..558a82eab0 100644 --- a/content/docs/other-guides/upgrade.md +++ b/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 b/content/docs/use-cases/job-scheduling.md similarity index 100% rename from content/docs/other-guides/job-scheduling.md rename to content/docs/use-cases/job-scheduling.md