Signed-off-by: Samhita Alla aallasamhita@gmail.com (#955)

Co-authored-by: Niels Bantilan niels.bantilan@gmail.com Documentation revamp restructuring according to the RFC: https://docs.google.com/document/d/1Yp5cYujKT6UMv17Y6r1djMchaMZWAlPNUTZnbw1sZvc/edit#heading=h.vozt1qaes3ur Signed-off-by: cosmicBboy <niels.bantilan@gmail.com> Co-authored-by: Samhita Alla <aallasamhita@gmail.com> Signed-off-by: Haytham Abuelfutuh <haytham@afutuh.com>
flyteorg · May 1, 2021 · 870ac8f · 870ac8f
1 parent 6c25396
commit 870ac8f
Show file tree

Hide file tree

Showing 60 changed files with 142 additions and 534 deletions.
diff --git a/doc-requirements.in b/doc-requirements.in
@@ -1,4 +1,4 @@
-furo
+git+git://github.com/flyteorg/furo@main
 readthedocs-sphinx-search
 sphinx
 sphinx-prompt

diff --git a/doc-requirements.txt b/doc-requirements.txt
@@ -6,9 +6,9 @@
 #
 alabaster==0.7.12
     # via sphinx
-astroid==2.5.2
+astroid==2.5.6
     # via sphinx-autoapi
-babel==2.9.0
+babel==2.9.1
     # via sphinx
 beautifulsoup4==4.9.3
     # via
@@ -20,7 +20,7 @@ chardet==4.0.0
     # via requests
 docutils==0.16
     # via sphinx
-furo==2021.3.20b30
+git+git://github.com/flyteorg/furo@main
     # via -r doc-requirements.in
 idna==2.10
     # via requests
@@ -59,7 +59,7 @@ snowballstemmer==2.1.0
     # via sphinx
 soupsieve==2.2.1
     # via beautifulsoup4
-sphinx-autoapi==1.7.0
+sphinx-autoapi==1.8.1
     # via -r doc-requirements.in
 sphinx-code-include==1.1.1
     # via -r doc-requirements.in
@@ -71,7 +71,7 @@ sphinx-prompt==1.4.0
     # via -r doc-requirements.in
 sphinx-tabs==2.1.0
     # via -r doc-requirements.in
-sphinx==3.5.3
+sphinx==3.5.4
     # via
     #   -r doc-requirements.in
     #   furo

diff --git a/rsts/_static/custom.css b/rsts/_static/custom.css
diff --git a/rsts/community/compare.rst b/rsts/community/compare.rst
diff --git a/rsts/dive_deep/admin.rst → rsts/concepts/admin.rst b/rsts/dive_deep/admin.rst → rsts/concepts/admin.rst
diff --git a/rsts/dive_deep/admin_service.rst → rsts/concepts/admin_service.rst b/rsts/dive_deep/admin_service.rst → rsts/concepts/admin_service.rst
diff --git a/rsts/dive_deep/architecture.rst → rsts/concepts/architecture.rst b/rsts/dive_deep/architecture.rst → rsts/concepts/architecture.rst
diff --git a/rsts/concepts/basics.rst b/rsts/concepts/basics.rst
@@ -0,0 +1,18 @@
+.. _basics:
+
+######
+Basics
+######
+
+.. NOTE::
+
+    Coming soon 🛠
+
+.. toctree::
+    :maxdepth: 1
+    :name: Basics
+
+    flyte_ui
+    flyte_cli
+    deployment_options
+    glossary
diff --git a/rsts/dive_deep/catalog.rst → rsts/concepts/catalog.rst b/rsts/dive_deep/catalog.rst → rsts/concepts/catalog.rst
diff --git a/rsts/dive_deep/console.rst → rsts/concepts/console.rst b/rsts/dive_deep/console.rst → rsts/concepts/console.rst
diff --git a/rsts/concepts/control_plane.rst b/rsts/concepts/control_plane.rst
@@ -0,0 +1,13 @@
+################
+Control Plane
+################
+
+.. toctree::
+    :maxdepth: 1
+
+    projects
+    domains
+    admin
+    admin_service
+    registration
+    console
diff --git a/rsts/concepts/core.rst b/rsts/concepts/core.rst
@@ -0,0 +1,15 @@
+.. _divedeep:
+
+############################
+Core Concepts & Architecture
+############################
+
+.. toctree::
+    :maxdepth: 1
+    :name: Concepts & Architecture
+
+    overview
+    tasks
+    workflows_nodes
+    launchplans_schedules
+    architecture
diff --git a/rsts/dive_deep/customizable_resources.rst → rsts/concepts/customizable_resources.rst b/rsts/dive_deep/customizable_resources.rst → rsts/concepts/customizable_resources.rst
diff --git a/rsts/concepts/deployment_options.rst b/rsts/concepts/deployment_options.rst
@@ -0,0 +1,7 @@
+###################################
+Deployment options (Local & Remote)
+###################################
+
+.. NOTE::
+
+    Coming soon 🛠
diff --git a/rsts/dive_deep/domains.rst → rsts/concepts/domains.rst b/rsts/dive_deep/domains.rst → rsts/concepts/domains.rst
diff --git a/rsts/dive_deep/dynamic_spec.rst → rsts/concepts/dynamic_spec.rst b/rsts/dive_deep/dynamic_spec.rst → rsts/concepts/dynamic_spec.rst
diff --git a/rsts/concepts/execution_time.rst b/rsts/concepts/execution_time.rst
@@ -0,0 +1,14 @@
+######################
+Execution Time Details
+######################
+
+.. toctree::
+    :maxdepth: 1
+
+    executions
+    state_machine
+    execution_timeline
+    observability
+    dynamic_spec
+    catalog
+    customizable_resources
diff --git a/rsts/dive_deep/execution_timeline.rst → rsts/concepts/execution_timeline.rst b/rsts/dive_deep/execution_timeline.rst → rsts/concepts/execution_timeline.rst
diff --git a/rsts/dive_deep/executions.rst → rsts/concepts/executions.rst b/rsts/dive_deep/executions.rst → rsts/concepts/executions.rst
diff --git a/rsts/concepts/flyte_cli.rst b/rsts/concepts/flyte_cli.rst
@@ -0,0 +1,7 @@
+##############
+Flyte CLI
+##############
+
+.. NOTE::
+
+    Coming soon 🛠
diff --git a/rsts/concepts/flyte_ui.rst b/rsts/concepts/flyte_ui.rst
@@ -0,0 +1,7 @@
+#################
+Flyte UI
+#################
+
+.. NOTE::
+
+    Coming soon 🛠
diff --git a/rsts/dive_deep/flyte_wf_tasks_high_level.png → rsts/concepts/flyte_wf_tasks_high_level.png b/rsts/dive_deep/flyte_wf_tasks_high_level.png → rsts/concepts/flyte_wf_tasks_high_level.png
diff --git a/rsts/concepts/glossary.rst b/rsts/concepts/glossary.rst
@@ -0,0 +1,12 @@
+############
+Glossary
+############
+
+.. glossary::
+
+    Memoization
+    Memoization ensures that a method doesn't run for the same inputs more than once by keeping a record of the results for the given inputs.
+
+.. NOTE::
+
+    Coming soon 🛠
diff --git a/rsts/dive_deep/launchplans_schedules.rst → rsts/concepts/launchplans_schedules.rst b/rsts/dive_deep/launchplans_schedules.rst → rsts/concepts/launchplans_schedules.rst
diff --git a/rsts/dive_deep/observability.rst → rsts/concepts/observability.rst b/rsts/dive_deep/observability.rst → rsts/concepts/observability.rst
diff --git a/rsts/dive_deep/overview.rst → rsts/concepts/overview.rst b/rsts/dive_deep/overview.rst → rsts/concepts/overview.rst
diff --git a/rsts/dive_deep/projects.rst → rsts/concepts/projects.rst b/rsts/dive_deep/projects.rst → rsts/concepts/projects.rst
diff --git a/rsts/dive_deep/registration.rst → rsts/concepts/registration.rst b/rsts/dive_deep/registration.rst → rsts/concepts/registration.rst
diff --git a/rsts/dive_deep/state_machine.rst → rsts/concepts/state_machine.rst b/rsts/dive_deep/state_machine.rst → rsts/concepts/state_machine.rst
diff --git a/rsts/dive_deep/tasks.rst → rsts/concepts/tasks.rst b/rsts/dive_deep/tasks.rst → rsts/concepts/tasks.rst
diff --git a/rsts/dive_deep/workflows_nodes.rst → rsts/concepts/workflows_nodes.rst b/rsts/dive_deep/workflows_nodes.rst → rsts/concepts/workflows_nodes.rst
diff --git a/rsts/conf.py b/rsts/conf.py
@@ -111,10 +111,6 @@
 pygments_style = "tango"
 pygments_dark_style = "native"
 
-html_css_files = [
-    "custom.css",
-]
-
 html_theme_options = {
     "light_css_variables": {
         "color-brand-primary": "#4300c9",

diff --git a/rsts/dive_deep/index.rst b/rsts/dive_deep/index.rst
diff --git a/rsts/howto/enable_and_use_schedules.rst b/rsts/howto/enable_and_use_schedules.rst
@@ -165,7 +165,7 @@ Workflow Executor
 -----------------
 Scheduled events which trigger need to be handled by the workflow executor, which subscribes to triggered events from the SQS queue you've configured above.
 
-.. CAUTION::
+.. NOTE::
 
    Failure to configure a workflow executor will result in all your scheduled events piling up silently without ever kicking off workflow executions.
 

diff --git a/rsts/howto/execute_workflow.rst b/rsts/howto/execute_workflow.rst
@@ -4,6 +4,6 @@
 How do I execute a workflow?
 ####################################
 
-.. CAUTION::
+.. NOTE::
 
     Coming soon 🛠
diff --git a/rsts/howto/fast_registration.rst b/rsts/howto/fast_registration.rst
@@ -4,7 +4,7 @@
 How do I use Fast Registration?
 ********************************
 
-.. caution:: Experimental feature (beta)
+.. NOTE:: Experimental feature (beta)
 
 Are you frustrated by having to wait for an image build in order to test out simple code changes to your Flyte workflows? If you're interested in reducing to your iteration cycle to mere seconds, read on below.
 

diff --git a/rsts/howto/install_sdk.rst b/rsts/howto/install_sdk.rst
@@ -21,6 +21,6 @@ All Flytekiplugins are also published to pypi as independent libraries and can b
 How to install Flytekit Java?
 #################################
 
-.. CAUTION::
+.. NOTE::
 
     Coming soon 🛠
diff --git a/rsts/howto/interruptible.rst b/rsts/howto/interruptible.rst
@@ -49,6 +49,6 @@ Most Flyte workloads should be good candidates for spot instances. If your task
 How to recover from interruptions?
 ===================================
 
-.. CAUTION::
+.. NOTE::
 
     Coming soon 🛠
diff --git a/rsts/howto/new_project.rst b/rsts/howto/new_project.rst
@@ -7,7 +7,7 @@ How do I create/register a new project?
 Using flytectl
 ---------------
 
-.. CAUTION::
+.. NOTE::
 
   Coming soon 🛠
 
@@ -27,6 +27,6 @@ If you refresh your console you'll see your new project appear!
 FlyteAdmin API reference
 -------------------------
 
-.. CAUTION::
+.. NOTE::
 
   Coming soon 🛠
diff --git a/rsts/howto/performance/index.rst b/rsts/howto/performance/index.rst
@@ -4,6 +4,6 @@
 How do I optimize performance of my Flyte Deployment?
 ######################################################
 
-.. CAUTION::
+.. NOTE::
 
     Coming soon 🛠
diff --git a/rsts/howto/resource_manager/index.rst b/rsts/howto/resource_manager/index.rst
@@ -5,6 +5,6 @@
 How do I enable and configure resource manager?
 #################################################
 
-.. CAUTION::
+.. NOTE::
 
     Coming soon 🛠
diff --git a/rsts/howto/resource_quota.rst b/rsts/howto/resource_quota.rst
@@ -4,6 +4,6 @@
 How do I limit resources per project/domain?
 ###############################################
 
-.. CAUTION::
+.. NOTE::
 
     Coming soon 🛠