Skip to content

Commit

Permalink
[Docs] Fix toctree links to User Guide, Environment Setup, and Contri…
Browse files Browse the repository at this point in the history
…buting sections (#4781)

* point to the right place for user guide, environment setup, and contributing landing pages

Signed-off-by: nikki everett <[email protected]>

* fix additional links

Signed-off-by: nikki everett <[email protected]>

* fix getting started links

Signed-off-by: nikki everett <[email protected]>

* fix tutorials links

Signed-off-by: nikki everett <[email protected]>

* remove toctree

Signed-off-by: nikki everett <[email protected]>

* re-add workflow dev toctree

Signed-off-by: nikki everett <[email protected]>

---------

Signed-off-by: nikki everett <[email protected]>
  • Loading branch information
neverett authored Jan 26, 2024
1 parent 42d3866 commit ac5603b
Showing 1 changed file with 4 additions and 92 deletions.
96 changes: 4 additions & 92 deletions docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,103 +37,15 @@ Flyte is made up of a user plane, control plane, and data plane.
* To create a Flyte project that can be used to package workflow code for deployment to a Flyte cluster, see {ref}`"Getting started with workflow development" <getting_started_workflow_development>`.
* To set up a Flyte cluster, see the [Deployment documentation](https://docs.flyte.org/en/latest/deployment/index.html).

```{toctree}
:maxdepth: 1
:hidden:
Getting Started <self>
User Guide <userguide>
Tutorials <tutorials>
Concepts <https://docs.flyte.org/en/latest/concepts/basics.html>
Deployment <https://docs.flyte.org/en/latest/deployment/index.html>
API Reference <https://docs.flyte.org/en/latest/reference/index.html>
Community <https://docs.flyte.org/en/latest/community/index.html>
```

```{toctree}
:maxdepth: -1
:caption: Getting Started
:hidden:
Introduction to Flyte <self>
getting_started/quickstart_guide
getting_started/getting_started_with_workflow_development
getting_started/flyte_fundamentals
getting_started/core_use_cases
```

```{toctree}
:maxdepth: -1
:caption: User Guide
:hidden:
📖 User Guide <userguide>
🌳 Environment Setup <environment_setup>
🔤 Basics <auto_examples/basics/index>
⌨️ Data Types and IO <auto_examples/data_types_and_io/index>
🔮 Advanced Composition <auto_examples/advanced_composition/index>
🧩 Customizing Dependencies <auto_examples/customizing_dependencies/index>
🏡 Development Lifecycle <auto_examples/development_lifecycle/index>
⚗️ Testing <auto_examples/testing/index>
🚢 Productionizing <auto_examples/productionizing/index>
🏗 Extending <auto_examples/extending/index>
📝 Contributing <contribute>
```

```{toctree}
:maxdepth: -1
:caption: Tutorials
:hidden:
Tutorials <tutorials>
Model Training <ml_training>
feature_engineering
bioinformatics_examples
flyte_lab
```

```{toctree}
:maxdepth: -1
:caption: Integrations
:hidden:
Integrations <integrations>
auto_examples/airflow_plugin/index
auto_examples/athena_plugin/index
auto_examples/aws_batch_plugin/index
auto_examples/sagemaker_pytorch_plugin/index
auto_examples/sagemaker_training_plugin/index
auto_examples/bigquery_plugin/index
auto_examples/k8s_dask_plugin/index
auto_examples/databricks_plugin/index
auto_examples/dbt_plugin/index
auto_examples/dolt_plugin/index
auto_examples/duckdb_plugin/index
auto_examples/flyin_plugin/index
auto_examples/greatexpectations_plugin/index
auto_examples/hive_plugin/index
auto_examples/k8s_pod_plugin/index
auto_examples/mlflow_plugin/index
auto_examples/mmcloud_plugin/index
auto_examples/modin_plugin/index
auto_examples/kfmpi_plugin/index
auto_examples/onnx_plugin/index
auto_examples/papermill_plugin/index
auto_examples/pandera_plugin/index
auto_examples/kfpytorch_plugin/index
auto_examples/ray_plugin/index
auto_examples/sensor/index
auto_examples/snowflake_plugin/index
auto_examples/k8s_spark_plugin/index
auto_examples/sql_plugin/index
auto_examples/kftensorflow_plugin/index
auto_examples/whylogs_plugin/index
```

```{toctree}
:maxdepth: -1
:caption: Tags
:hidden:
_tags/tagsindex
flytesnacks/getting_started/quickstart_guide
flytesnacks/getting_started/getting_started_with_workflow_development
flytesnacks/getting_started/flyte_fundamentals
flytesnacks/getting_started/core_use_cases
```

0 comments on commit ac5603b

Please sign in to comment.