make user guide prominent (#349)

* make the heading more readable * top heading should match file intent * surface user guide * Update README.md
red-hat-data-services · Oct 30, 2020 · 53dc4f2 · 53dc4f2
1 parent 905079b
commit 53dc4f2
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -25,6 +25,8 @@ We are currently using [Kubeflow Pipelines 1.0.0](https://github.com/kubeflow/pi
 
 [Install Kubeflow Pipelines with Tekton backend](tekton_kfp_guide.md)
 
+[KFP Tekton Pipelines User Guide](/samples/kfp-user-guide/README.md)
+
 [Use KFP Tekton SDK](/sdk/README.md)
 
 [Run Samples](/samples/README.md)

diff --git a/samples/README.md b/samples/README.md
@@ -1,11 +1,10 @@
-# KFP Tekton User Guide
-[KFP Tekton User Guide](/samples/kfp-user-guide) is a guideline for the possible ways to develop and consume Kubeflow Pipeline with Tekton. It's recommended to go over at least one of the methods in the user guide before heading into the KFP Tekton Samples.
-
 # KFP Tekton Samples
 
 Below are the list of samples that are currently running end to end taking the compiled Tekton yaml and deploying on a Tekton cluster directly. 
 If you are interested more in the larger list of pipelines samples we are testing for whether they can be 'compiled to Tekton' format, please [look at the corresponding status page](/sdk/python/tests/README.md)
 
+[KFP Tekton User Guide](/samples/kfp-user-guide) is a guideline for the possible ways to develop and consume Kubeflow Pipeline with Tekton. It's recommended to go over at least one of the methods in the user guide before heading into the KFP Tekton Samples.
+
 ## Prerequisites 
 - Install [Kubeflow 1.0.2+](https://www.kubeflow.org/docs/started/getting-started/) and connect the cluster to the current shell with `kubectl`
 - Install [Tekton 0.14.0](https://github.com/tektoncd/pipeline/releases/tag/v0.14.0)

diff --git a/samples/kfp-user-guide/README.md b/samples/kfp-user-guide/README.md
@@ -1,4 +1,4 @@
-# Kubeflow pipeline user guide
+# Kubeflow Pipelines with Tekton User Guide
 
 This page introduces different ways to compile, upload, and execute Kubeflow Pipelines with Tekton backend. The usual flow for using the Kubeflow Pipeline is to compile the Kubeflow Pipeline Python DSL into a Tekton formatted file. Then upload the compiled file to the Kubeflow Pipeline platform. Lastly, execute the uploaded pipeline using the Kubeflow Pipeline backend engine. For starter, we recommend using the first method in each section.