Skip to content

Commit

Permalink
More updates
Browse files Browse the repository at this point in the history
  • Loading branch information
kumare3 committed Feb 12, 2021
1 parent 7015aa8 commit 58cd037
Show file tree
Hide file tree
Showing 11 changed files with 41 additions and 54 deletions.
12 changes: 0 additions & 12 deletions rsts/community/contribute/index.rst

This file was deleted.

File renamed without changes.
19 changes: 8 additions & 11 deletions rsts/community/index.rst
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -13,12 +13,9 @@ so please join us on the
- `Email <https://groups.google.com/a/flyte.org/d/forum/users>`_
- `Twitter <https://twitter.com/flyteorg>`_

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
4 changes: 2 additions & 2 deletions rsts/howto/sandbox/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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 <tutorials-getting-started-flyte-laptop>` with deploying the sandbox
We'll proceed like with :ref:`locally hosted flyte <tutorials-getting-started-run-on-flyte>` with deploying the sandbox
Flyte configuration on your remote cluster.

.. warning::
Expand Down
11 changes: 8 additions & 3 deletions rsts/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -36,4 +38,7 @@ Welcome to the documentation hub for Flyte.
:name: roadmaptoc

community/index
community/docs
community/roadmap
community/compare

11 changes: 6 additions & 5 deletions rsts/plugins/index.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 3 additions & 3 deletions rsts/reference/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _reference:

###############################
Reference
###############################
#################################
API, CLI and Component Reference
#################################


.. toctree::
Expand Down
6 changes: 3 additions & 3 deletions rsts/tutorials/first_example.rst
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
14 changes: 0 additions & 14 deletions rsts/tutorials/index.rst

This file was deleted.

10 changes: 10 additions & 0 deletions rsts/tutorials/learn.rst
Original file line number Diff line number Diff line change
@@ -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 <https://flytecookbook.readthedocs.io/en/latest/>`_
=========================================================================================
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _tutorials-getting-started-flyte-laptop:
.. _tutorials-getting-started-run-on-flyte:

######################################
Run Your Workflow on a Flyte Backend
Expand Down

0 comments on commit 58cd037

Please sign in to comment.