diff --git a/rsts/community/contribute/index.rst b/rsts/community/contribute/index.rst deleted file mode 100644 index 94b2763ae9..0000000000 --- a/rsts/community/contribute/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _community_contribute: - -###################### -Contributor Handbook -###################### - -.. toctree:: - :caption: contribute - :maxdepth: 1 - :name: communitycontributetoc - - docs diff --git a/rsts/community/contribute/docs.rst b/rsts/community/docs.rst similarity index 100% rename from rsts/community/contribute/docs.rst rename to rsts/community/docs.rst diff --git a/rsts/community/index.rst b/rsts/community/index.rst index a97bdf0430..6fbb8e96b5 100644 --- a/rsts/community/index.rst +++ b/rsts/community/index.rst @@ -1,8 +1,8 @@ .. _community: -##################################### -Community, Roadmap, and Contributions -##################################### +########## +Community +########## Flyte is an ambitious open source project and would not be possible without an amazing community. We are a completely open community and we vouch to treat @@ -13,12 +13,9 @@ so please join us on the - `Email `_ - `Twitter `_ +We love contributions, so please contribute to + - docs + - examples + - new plugins or plugin ideas + - just feedback in general -.. toctree:: - :caption: Be nice! - :maxdepth: 1 - :name: communityinnertoc - - contribute/index - roadmap - compare diff --git a/rsts/howto/sandbox/index.rst b/rsts/howto/sandbox/index.rst index f53d812557..dd4dd4e31e 100644 --- a/rsts/howto/sandbox/index.rst +++ b/rsts/howto/sandbox/index.rst @@ -22,7 +22,7 @@ Deploy Flyte Sandbox environment locally - on your laptop ********************************************************* Flyte Sandbox deployment can be run locally on your laptop. This will allow only some of the functionality, but is great to get started with. -Refer to :ref:`tutorials-getting-started-flyte-laptop`. +Refer to :ref:`tutorials-getting-started-run-on-flyte`. .. _howto-sandbox-dedicated-k8s-cluster: @@ -46,7 +46,7 @@ If you can access your cluster with ``kubectl cluster-info``, you're ready to de Deployment ========== -We'll proceed like with :ref:`locally hosted flyte ` with deploying the sandbox +We'll proceed like with :ref:`locally hosted flyte ` with deploying the sandbox Flyte configuration on your remote cluster. .. warning:: diff --git a/rsts/index.rst b/rsts/index.rst index 36b343f8c8..125b3ea50d 100644 --- a/rsts/index.rst +++ b/rsts/index.rst @@ -8,17 +8,19 @@ Welcome to the documentation hub for Flyte. .. toctree:: :maxdepth: 1 - :caption: Take off with Flyte + :caption: Get started with Flyte :name: tutorialstoc - tutorials/index - plugins/index + tutorials/first_example + tutorials/run_on_flyte + tutorials/learn .. toctree:: :caption: How to Guides :maxdepth: 1 :name: howtotoc + plugins/index howto/index faq/index @@ -36,4 +38,7 @@ Welcome to the documentation hub for Flyte. :name: roadmaptoc community/index + community/docs + community/roadmap + community/compare diff --git a/rsts/plugins/index.rst b/rsts/plugins/index.rst index 02e941fe71..c47b125ef0 100644 --- a/rsts/plugins/index.rst +++ b/rsts/plugins/index.rst @@ -1,12 +1,13 @@ .. _plugins: -######## -Plugins -######## +#################### +Available Plugins +#################### + +Following is a list of maintained plugins for Flyte and guides on how to install / use them. .. toctree:: - :maxdepth: 2 - :caption: Available Plugins + :maxdepth: 1 :name: pluginstoc spark_k8s diff --git a/rsts/reference/index.rst b/rsts/reference/index.rst index d59a33d844..32281a70c4 100644 --- a/rsts/reference/index.rst +++ b/rsts/reference/index.rst @@ -1,8 +1,8 @@ .. _reference: -############################### -Reference -############################### +################################# +API, CLI and Component Reference +################################# .. toctree:: diff --git a/rsts/tutorials/first_example.rst b/rsts/tutorials/first_example.rst index 2b10cc1af8..f59d8c95bc 100644 --- a/rsts/tutorials/first_example.rst +++ b/rsts/tutorials/first_example.rst @@ -1,8 +1,8 @@ .. _tutorials-getting-started-first-example: -########################### -Writing Your First Workflow -########################### +###################################### +Write your first Flyte workflow +###################################### By the end of this getting started guide you'll be familiar with how easy it is to author a Flyte workflow and run it locally. diff --git a/rsts/tutorials/index.rst b/rsts/tutorials/index.rst deleted file mode 100644 index eea28f7599..0000000000 --- a/rsts/tutorials/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _tutorials: - -############################## -Getting Started and Tutorials -############################## - -.. toctree:: - :maxdepth: 1 - :caption: Flyte Tutorials - :name: tutorialsecstoc - - first_example - run_flyte_laptop - Learn by example - Flytekit Python diff --git a/rsts/tutorials/learn.rst b/rsts/tutorials/learn.rst new file mode 100644 index 0000000000..1a87c3adff --- /dev/null +++ b/rsts/tutorials/learn.rst @@ -0,0 +1,10 @@ +.. _tutorials-learn: + +########################### +Learn Flytekit by Example +########################### + +Flytekit implements a programming model for Flyte in (python and Java). The best way to see the capabilities of Flyte is to try out Flytekit. + +`Learn by example - Flytekit Python `_ +========================================================================================= diff --git a/rsts/tutorials/run_flyte_laptop.rst b/rsts/tutorials/run_on_flyte.rst similarity index 99% rename from rsts/tutorials/run_flyte_laptop.rst rename to rsts/tutorials/run_on_flyte.rst index ebc36d686e..075a2d1e86 100644 --- a/rsts/tutorials/run_flyte_laptop.rst +++ b/rsts/tutorials/run_on_flyte.rst @@ -1,4 +1,4 @@ -.. _tutorials-getting-started-flyte-laptop: +.. _tutorials-getting-started-run-on-flyte: ###################################### Run Your Workflow on a Flyte Backend