Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactored 'Other Guides' and applied redirects #1064

Merged
merged 1 commit into from
Aug 12, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion content/_redirects
Original file line number Diff line number Diff line change
Expand Up @@ -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/
2 changes: 1 addition & 1 deletion content/docs/components/training/tftraining.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2 changes: 1 addition & 1 deletion content/docs/gke/deploy/deploy-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion content/docs/gke/deploy/deploy-ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion content/docs/notebooks/troubleshoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions content/docs/other-guides/_index.md
Original file line number Diff line number Diff line change
@@ -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
+++
2 changes: 1 addition & 1 deletion content/docs/other-guides/accessing-uis.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion content/docs/other-guides/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
+++
title = "Troubleshooting"
description = "Finding and fixing problems in your Kubeflow deployment"
weight = 20
weight = 100
+++


Expand Down
1 change: 1 addition & 0 deletions content/docs/other-guides/usage-reporting.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
+++
title = "Usage Reporting"
description = "Opting in or out of anonymous usage data reported from Kubeflow"
weight = 40
+++

Expand Down
6 changes: 3 additions & 3 deletions content/docs/started/workstation/getting-started-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand All @@ -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.
6 changes: 3 additions & 3 deletions content/docs/started/workstation/getting-started-macos.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand All @@ -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.
6 changes: 3 additions & 3 deletions content/docs/started/workstation/getting-started-windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand All @@ -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.
5 changes: 5 additions & 0 deletions content/docs/upgrading/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
+++
title = "Upgrading Kubeflow"
description = "Guides to upgrading your Kubeflow deployment"
weight = 100
+++
Original file line number Diff line number Diff line change
@@ -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
+++

Expand Down