From 413602fb4d4abc6a8a162ddc021dcbf6c8beb303 Mon Sep 17 00:00:00 2001 From: Sarah Maddox Date: Mon, 3 Dec 2018 15:17:20 +1100 Subject: [PATCH] Adjusted page front matter for the 'Components' section. --- content/docs/guides/_index.md | 3 ++- content/docs/guides/components/_index.md | 2 +- content/docs/guides/components/chainer.md | 9 +++------ content/docs/guides/components/components.md | 6 +----- content/docs/guides/components/hyperparameter.md | 9 ++------- content/docs/guides/components/istio.md | 9 ++------- content/docs/guides/components/jupyter.md | 6 +----- content/docs/guides/components/ksonnet.md | 9 ++------- content/docs/guides/components/mpi.md | 10 +++------- content/docs/guides/components/mxnet.md | 10 +++------- content/docs/guides/components/pipelines.md | 7 +------ content/docs/guides/components/pytorch.md | 10 +++------- content/docs/guides/components/pytorchserving.md | 9 ++------- content/docs/guides/components/seldon.md | 10 ++-------- content/docs/guides/components/tfbatchpredict.md | 10 ++-------- content/docs/guides/components/tfserving.md | 10 ++-------- content/docs/guides/components/tfserving_new.md | 10 ++-------- content/docs/guides/components/tftraining.md | 10 +++------- content/docs/guides/components/trtinferenceserver.md | 10 ++-------- .../search.js_b4bb3e7b21b43e920b7c367ff787d383.content | 2 +- 20 files changed, 40 insertions(+), 121 deletions(-) diff --git a/content/docs/guides/_index.md b/content/docs/guides/_index.md index ff065384be..a88a0a2754 100644 --- a/content/docs/guides/_index.md +++ b/content/docs/guides/_index.md @@ -1,4 +1,5 @@ +++ title = "Guides" -description = "How-to instructions on using Kubeflow." +description = "Step-by-step instructions on how to use Kubeflow" +weight = 3 +++ diff --git a/content/docs/guides/components/_index.md b/content/docs/guides/components/_index.md index 3a9f19c90c..e83c9f8a28 100644 --- a/content/docs/guides/components/_index.md +++ b/content/docs/guides/components/_index.md @@ -1,5 +1,5 @@ +++ title = "Components of Kubeflow" -description = "Logical components that make up Kubeflow." +description = "Logical components that make up Kubeflow" weight = 2 +++ diff --git a/content/docs/guides/components/chainer.md b/content/docs/guides/components/chainer.md index 7bfd5f3ca4..96438dd99c 100644 --- a/content/docs/guides/components/chainer.md +++ b/content/docs/guides/components/chainer.md @@ -1,15 +1,12 @@ +++ title = "Chainer Training" description = "Instructions for using Chainer for training" -weight = 10 +weight = 4 toc = true -bref= "This guide will walk you through using Chainer for training" -[menu] -[menu.docs] - parent = "components" - weight = 4 +++ +This guide walks you through using Chainer for training your model. + ## What is Chainer? [Chainer](https://chainer.org/) is a powerful, flexible and intuitive deep learning framework. diff --git a/content/docs/guides/components/components.md b/content/docs/guides/components/components.md index 3228542dec..55fbd40a56 100644 --- a/content/docs/guides/components/components.md +++ b/content/docs/guides/components/components.md @@ -1,12 +1,8 @@ +++ title = "Components Overview" description = "Kubeflow components" -weight = 10 -toc = true +weight = 1 aliases = ["/docs/guides/components/", "/docs/components/"] -[menu.docs] - parent = "components" - weight = 1 +++ Kubeflow offers scripts and configuration files to activate a number of diff --git a/content/docs/guides/components/hyperparameter.md b/content/docs/guides/components/hyperparameter.md index 58171d433d..bfbb08d591 100644 --- a/content/docs/guides/components/hyperparameter.md +++ b/content/docs/guides/components/hyperparameter.md @@ -1,12 +1,7 @@ +++ title = "Hyperparameter Tuning (Katib)" -description = "Hyperparameter Tuning (Katib)" -weight = 10 -toc = true -[menu] -[menu.docs] - parent = "components" - weight = 5 +description = "Using Katib to tune your model's hyperparameters" +weight = 5 +++ ## Using Katib diff --git a/content/docs/guides/components/istio.md b/content/docs/guides/components/istio.md index dfe4b169f2..0e17e970d0 100644 --- a/content/docs/guides/components/istio.md +++ b/content/docs/guides/components/istio.md @@ -1,12 +1,7 @@ +++ title = "Istio Integration (for TF Serving)" -description = "Istio Integration (for TF Serving)" -weight = 10 -toc = true -[menu] -[menu.docs] - parent = "components" - weight = 6 +description = "Using Istio for TF Serving" +weight = 6 +++ [Istio](https://istio.io/) provides a lot of functionality that we want to have, such as metrics, auth and diff --git a/content/docs/guides/components/jupyter.md b/content/docs/guides/components/jupyter.md index 89e3a98c2c..310bfbb238 100644 --- a/content/docs/guides/components/jupyter.md +++ b/content/docs/guides/components/jupyter.md @@ -1,11 +1,7 @@ +++ title = "Jupyter Notebooks" +description = "Using Jupyter notebooks in Kubeflow" weight = 10 -toc = true -[menu] -[menu.docs] - parent = "components" - weight = 10 +++ ## Bringing up a Jupyter Notebook diff --git a/content/docs/guides/components/ksonnet.md b/content/docs/guides/components/ksonnet.md index da70f9753b..b6b9cb7153 100644 --- a/content/docs/guides/components/ksonnet.md +++ b/content/docs/guides/components/ksonnet.md @@ -1,12 +1,7 @@ +++ title = "ksonnet" -description = "ksonnet information related to Kubeflow" -weight = 10 -toc = true -[menu] -[menu.docs] - parent = "components" - weight = 20 +description = "Information about ksonnet as used in Kubeflow" +weight = 20 +++ Kubeflow makes use of [ksonnet] to help manage deployments. diff --git a/content/docs/guides/components/mpi.md b/content/docs/guides/components/mpi.md index 7ed8082862..d0d955d71b 100644 --- a/content/docs/guides/components/mpi.md +++ b/content/docs/guides/components/mpi.md @@ -1,15 +1,11 @@ +++ title = "MPI Training" description = "Instructions for using MPI for training" -weight = 10 -toc = true -bref= "This guide will walk you through using MPI for training" -[menu] -[menu.docs] - parent = "components" - weight = 25 +weight = 25 +++ +This guide walks you through using MPI for training. + ## Installing MPI Operator If you haven't already done so please follow the [Getting Started Guide](/docs/started/getting-started/) to deploy Kubeflow. diff --git a/content/docs/guides/components/mxnet.md b/content/docs/guides/components/mxnet.md index 0b6cc4dd0c..8d03e26338 100644 --- a/content/docs/guides/components/mxnet.md +++ b/content/docs/guides/components/mxnet.md @@ -1,15 +1,11 @@ +++ title = "MXNet Training" description = "Instructions for using MXNet" -weight = 10 -toc = true -bref= "This guide will walk you through using MXNet with Kubeflow" -[menu] -[menu.docs] - parent = "components" - weight = 25 +weight = 25 +++ +This guide walks you through using MXNet with Kubeflow. + ## Installing MXNet Operator If you haven't already done so please follow the [Getting Started Guide](https://www.kubeflow.org/docs/started/getting-started/) to deploy Kubeflow. diff --git a/content/docs/guides/components/pipelines.md b/content/docs/guides/components/pipelines.md index 775a34abe6..7af919101b 100644 --- a/content/docs/guides/components/pipelines.md +++ b/content/docs/guides/components/pipelines.md @@ -1,12 +1,7 @@ +++ title = "Pipelines" description = "Introduction to Kubeflow Pipelines" -weight = 10 -toc = true -[menu] -[menu.docs] - parent = "components" - weight = 35 +weight = 35 +++ Kubeflow Pipelines is a platform for building and deploying portable and diff --git a/content/docs/guides/components/pytorch.md b/content/docs/guides/components/pytorch.md index 445eb402a8..7c8da38337 100644 --- a/content/docs/guides/components/pytorch.md +++ b/content/docs/guides/components/pytorch.md @@ -1,15 +1,11 @@ +++ title = "PyTorch Training" description = "Instructions for using PyTorch" -weight = 10 -toc = true -bref= "This guide will walk you through using PyTorch with Kubeflow" -[menu] -[menu.docs] - parent = "components" - weight = 35 +weight = 35 +++ +This guide walks you through using PyTorch with Kubeflow. + ## Installing PyTorch Operator If you haven't already done so please follow the [Getting Started Guide](/docs/started/getting-started/) to deploy Kubeflow. diff --git a/content/docs/guides/components/pytorchserving.md b/content/docs/guides/components/pytorchserving.md index 7bc46a3502..8475e7b392 100644 --- a/content/docs/guides/components/pytorchserving.md +++ b/content/docs/guides/components/pytorchserving.md @@ -1,15 +1,10 @@ +++ title = "PyTorch Serving" description = "Instructions for serving a PyTorch model with Seldon" -weight = 10 -toc = true -bref= "This guide will walk you through serving a PyTorch trained model in Kubeflow" -[menu] -[menu.docs] - parent = "components" - weight = 35 +++ +This guide walks you through serving a PyTorch trained model in Kubeflow. + ## Serving a model We use [seldon-core](https://github.com/SeldonIO/seldon-core) component deployed following [these](/docs/guides/components/seldon/) instructions to serve the model. diff --git a/content/docs/guides/components/seldon.md b/content/docs/guides/components/seldon.md index 3ca9afc150..afc8834ba5 100644 --- a/content/docs/guides/components/seldon.md +++ b/content/docs/guides/components/seldon.md @@ -1,13 +1,7 @@ +++ title = "Seldon Serving" -description = "Seldon Serving" -weight = 10 -toc = true -bref= "Model serving using Seldon" -[menu] -[menu.docs] - parent = "components" - weight = 40 +description = "Model serving using Seldon" +weight = 40 +++ ## Serve a model using Seldon diff --git a/content/docs/guides/components/tfbatchpredict.md b/content/docs/guides/components/tfbatchpredict.md index dea3d8bb44..5566ff8bee 100644 --- a/content/docs/guides/components/tfbatchpredict.md +++ b/content/docs/guides/components/tfbatchpredict.md @@ -1,13 +1,7 @@ +++ title = "TensorFlow Batch Predict" -description = "" -weight = 10 -toc = true -bref= "Batch Prediction for TensorFlow models" -[menu] -[menu.docs] - parent = "components" - weight = 60 +description = "Batch prediction for TensorFlow models" +weight = 60 +++ ## Kubeflow Batch Predict diff --git a/content/docs/guides/components/tfserving.md b/content/docs/guides/components/tfserving.md index 66523efd11..190d4d627d 100644 --- a/content/docs/guides/components/tfserving.md +++ b/content/docs/guides/components/tfserving.md @@ -1,13 +1,7 @@ +++ title = "TensorFlow Serving" -description = "" -weight = 10 -toc = true -bref= "Training and serving using TFJob" -[menu] -[menu.docs] - parent = "components" - weight = 50 +description = "Training and serving using TFJob" +weight = 50 +++ ## Serving a model diff --git a/content/docs/guides/components/tfserving_new.md b/content/docs/guides/components/tfserving_new.md index 266bc82065..e2611fbd5e 100644 --- a/content/docs/guides/components/tfserving_new.md +++ b/content/docs/guides/components/tfserving_new.md @@ -1,13 +1,7 @@ +++ title = "TensorFlow Serving (new)" -description = "" -weight = 10 -toc = true -bref= "Serving Tensorflow models" -[menu] -[menu.docs] - parent = "components" - weight = 51 +description = "Serving Tensorflow models" +weight = 51 +++ This document is for the new Kubeflow TF Serving diff --git a/content/docs/guides/components/tftraining.md b/content/docs/guides/components/tftraining.md index 2ae682558c..b9625044a9 100644 --- a/content/docs/guides/components/tftraining.md +++ b/content/docs/guides/components/tftraining.md @@ -2,15 +2,11 @@ title = "TensorFlow Training (TFJob)" linkTitle = "TensorFlow Training (TFJob)" description = "" -weight = 10 -toc = true -bref= "This page describes TFJob for training a machine learning model with TensorFlow." -[menu] -[menu.docs] - parent = "components" - weight = 60 +weight = 60 +++ +This page describes TFJob for training a machine learning model with TensorFlow. + ## What is TFJob? TFJob is a Kubernetes diff --git a/content/docs/guides/components/trtinferenceserver.md b/content/docs/guides/components/trtinferenceserver.md index 7aa516fda6..947d2c1ea9 100644 --- a/content/docs/guides/components/trtinferenceserver.md +++ b/content/docs/guides/components/trtinferenceserver.md @@ -1,13 +1,7 @@ +++ title = "NVIDIA TensorRT Inference Server" -description = "" -weight = 10 -toc = true -bref= "Model serving using TRT Inference Server" -[menu] -[menu.docs] - parent = "components" - weight = 50 +description = "Model serving using TRT Inference Server" +weight = 50 +++ NVIDIA TensorRT Inference Server is a REST and GRPC service for deep-learning diff --git a/resources/_gen/assets/js/js/search.js_b4bb3e7b21b43e920b7c367ff787d383.content b/resources/_gen/assets/js/js/search.js_b4bb3e7b21b43e920b7c367ff787d383.content index e438589f2f..e80639ebca 100644 --- a/resources/_gen/assets/js/js/search.js_b4bb3e7b21b43e920b7c367ff787d383.content +++ b/resources/_gen/assets/js/js/search.js_b4bb3e7b21b43e920b7c367ff787d383.content @@ -27,7 +27,7 @@ limitations under the License. } var query = $(this).val(); - var searchPage = "/search/?q=" + query; + var searchPage = "//localhost:1313/search/?q=" + query; document.location = searchPage; return false;