Skip to content

Commit 9397746

Browse files
refactor Components / Kubeflow Pipelines section (#3063)
* refactor pipelines section * fix links & move "introduction" to root * revert rename of "TFX Compatibility Matrix"
1 parent e7f5353 commit 9397746

49 files changed

Lines changed: 134 additions & 124 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

content/en/_redirects

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,16 @@ docs/started/requirements/ /docs/started/getting-started/
167167
/docs/components/notebooks/troubleshoot /docs/components/notebooks/troubleshooting
168168
/docs/components/notebooks/why-use-jupyter-notebook /docs/components/notebooks/overview
169169

170+
# Refactor Pipelines section
171+
/docs/components/pipelines/caching /docs/components/pipelines/overview/caching
172+
/docs/components/pipelines/caching-v2 /docs/components/pipelines/overview/caching-v2
173+
/docs/components/pipelines/multi-user /docs/components/pipelines/overview/multi-user
174+
/docs/components/pipelines/pipeline-root /docs/components/pipelines/overview/pipeline-root
175+
/docs/components/pipelines/pipelines-overview /docs/components/pipelines/introduction
176+
/docs/components/pipelines/pipelines-quickstart /docs/components/pipelines/overview/quickstart
177+
/docs/components/pipelines/overview/concepts/* /docs/components/pipelines/concepts/:splat
178+
/docs/components/pipelines/sdk/v2/* /docs/components/pipelines/sdk-v2/:splat
179+
170180
# ===============
171181
# IMPORTANT NOTE:
172182
# Catch-all redirects should be added at the end of this file as redirects happen from top to bottom
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
+++
2+
title = "Concepts"
3+
description = "Concepts used in Kubeflow Pipelines"
4+
weight = 30
5+
+++

content/en/docs/components/pipelines/overview/concepts/component.md renamed to content/en/docs/components/pipelines/concepts/component.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ deserialize the data for use in the downstream component.
5757

5858
## Next steps
5959

60-
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/pipelines-overview/).
61-
* Follow the [pipelines quickstart guide](/docs/components/pipelines/pipelines-quickstart/)
60+
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/).
61+
* Follow the [pipelines quickstart guide](/docs/components/pipelines/overview/quickstart/)
6262
to deploy Kubeflow and run a sample pipeline directly from the Kubeflow
6363
Pipelines UI.
6464
* Build your own

content/en/docs/components/pipelines/overview/concepts/experiment.md renamed to content/en/docs/components/pipelines/concepts/experiment.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ weight = 40
88
An *experiment* is a workspace where you can try different configurations of
99
your pipelines. You can use experiments to organize your runs into logical
1010
groups. Experiments can contain arbitrary runs, including
11-
[recurring runs](/docs/components/pipelines/overview/concepts/run/).
11+
[recurring runs](/docs/components/pipelines/concepts/run/).
1212

1313
## Next steps
1414

15-
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/overview/pipelines-overview/).
16-
* Follow the [pipelines quickstart guide](/docs/components/pipelines/pipelines-quickstart/)
15+
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/).
16+
* Follow the [pipelines quickstart guide](/docs/components/pipelines/overview/quickstart/)
1717
to deploy Kubeflow and run a sample pipeline directly from the Kubeflow
1818
Pipelines UI.

content/en/docs/components/pipelines/overview/concepts/graph.md renamed to content/en/docs/components/pipelines/concepts/graph.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ parent contains a conditional clause.)
2424

2525
## Next steps
2626

27-
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/pipelines-overview/).
28-
* Follow the [pipelines quickstart guide](/docs/components/pipelines/pipelines-quickstart/)
27+
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/).
28+
* Follow the [pipelines quickstart guide](/docs/components/pipelines/overview/quickstart/)
2929
to deploy Kubeflow and run a sample pipeline directly from the Kubeflow
3030
Pipelines UI.

content/en/docs/components/pipelines/overview/concepts/output-artifact.md renamed to content/en/docs/components/pipelines/concepts/output-artifact.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ data to rich interactive visualizations.
1515

1616
## Next steps
1717

18-
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/overview/pipelines-overview/).
19-
* Follow the [pipelines quickstart guide](/docs/components/pipelines/pipelines-quickstart/)
18+
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/).
19+
* Follow the [pipelines quickstart guide](/docs/components/pipelines/overview/quickstart/)
2020
to deploy Kubeflow and run a sample pipeline directly from the Kubeflow
2121
Pipelines UI.
2222
* Read more about the available

content/en/docs/components/pipelines/overview/concepts/pipeline.md renamed to content/en/docs/components/pipelines/concepts/pipeline.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,19 @@ weight = 10
66
+++
77

88
A *pipeline* is a description of a machine learning (ML) workflow, including all
9-
of the [components](/docs/components/pipelines/overview/concepts/component/) in the workflow and how the components relate to each other in
10-
the form of a [graph](/docs/components/pipelines/overview/concepts/graph/). The pipeline
9+
of the [components](/docs/components/pipelines/concepts/component/) in the workflow and how the components relate to each other in
10+
the form of a [graph](/docs/components/pipelines/concepts/graph/). The pipeline
1111
configuration includes the definition of the inputs (parameters) required to run
1212
the pipeline and the inputs and outputs of each component.
1313

1414
When you run a pipeline, the system launches one or more Kubernetes Pods
15-
corresponding to the [steps](/docs/components/pipelines/overview/concepts/step/) (components) in your workflow (pipeline). The Pods
15+
corresponding to the [steps](/docs/components/pipelines/concepts/step/) (components) in your workflow (pipeline). The Pods
1616
start Docker containers, and the containers in turn start your programs.
1717

1818
After developing your pipeline, you can upload your pipeline using the Kubeflow Pipelines UI or the Kubeflow Pipelines SDK.
1919

2020
## Next steps
21-
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/overview/pipelines-overview/).
22-
* Follow the [pipelines quickstart guide](/docs/components/pipelines/pipelines-quickstart/)
21+
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/).
22+
* Follow the [pipelines quickstart guide](/docs/components/pipelines/overview/quickstart/)
2323
to deploy Kubeflow and run a sample pipeline directly from the Kubeflow
2424
Pipelines UI.

content/en/docs/components/pipelines/overview/concepts/run-trigger.md renamed to content/en/docs/components/pipelines/concepts/run-trigger.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ available:
1515

1616
## Next steps
1717

18-
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/overview/pipelines-overview/).
19-
* Follow the [pipelines quickstart guide](/docs/components/pipelines/pipelines-quickstart/)
18+
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/).
19+
* Follow the [pipelines quickstart guide](/docs/components/pipelines/overview/quickstart/)
2020
to deploy Kubeflow and run a sample pipeline directly from the Kubeflow
2121
Pipelines UI.

content/en/docs/components/pipelines/overview/concepts/run.md renamed to content/en/docs/components/pipelines/concepts/run.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ output artifacts, and logs for each step in the run.
1515
A *recurring run*, or job in the Kubeflow Pipelines [backend APIs](https://github.com/kubeflow/pipelines/tree/06e4dc660498ce10793d566ca50b8d0425b39981/backend/api/go_http_client/job_client), is a repeatable run of
1616
a pipeline. The configuration for a recurring run includes a copy of a pipeline
1717
with all parameter values specified and a
18-
[run trigger](/docs/components/pipelines/overview/concepts/run-trigger/).
18+
[run trigger](/docs/components/pipelines/concepts/run-trigger/).
1919
You can start a recurring run inside any experiment, and it will periodically
2020
start a new copy of the run configuration. You can enable/disable the recurring
2121
run from the Kubeflow Pipelines UI. You can also specify the maximum number of
@@ -25,7 +25,7 @@ triggered to run frequently.
2525

2626
## Next steps
2727

28-
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/pipelines-overview/).
29-
* Follow the [pipelines quickstart guide](/docs/components/pipelines/pipelines-quickstart/)
28+
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/).
29+
* Follow the [pipelines quickstart guide](/docs/components/pipelines/overview/quickstart/)
3030
to deploy Kubeflow and run a sample pipeline directly from the Kubeflow
3131
Pipelines UI.

content/en/docs/components/pipelines/overview/concepts/step.md renamed to content/en/docs/components/pipelines/concepts/step.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ an if/else like clause in the pipeline code.
1313

1414
## Next steps
1515

16-
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/pipelines-overview/).
17-
* Follow the [pipelines quickstart guide](/docs/components/pipelines/pipelines-quickstart/)
16+
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/).
17+
* Follow the [pipelines quickstart guide](/docs/components/pipelines/overview/quickstart/)
1818
to deploy Kubeflow and run a sample pipeline directly from the Kubeflow
1919
Pipelines UI.

0 commit comments

Comments
 (0)