From 69535019871f4c2db60362bd8044fa1031a71f7b Mon Sep 17 00:00:00 2001 From: Samhita Alla Date: Wed, 28 Apr 2021 18:07:39 +0530 Subject: [PATCH] Docs staging (#950) * dark theme updates (#883) Signed-off-by: cosmicBboy * Release automation addedd for flyte definition (#835) * wip: added script for release automation Signed-off-by: yuvraj * wip: added manual github workflow Signed-off-by: Yuvraj * wip: added release workflow Signed-off-by: Yuvraj * wip: fix e2e testcase Signed-off-by: Yuvraj * wip: small fixes Signed-off-by: Yuvraj * wip: revert version in kustomize Signed-off-by: Yuvraj * wip: revert kustomize changes Signed-off-by: Yuvraj * wip: added generated kustomize output Signed-off-by: yuvraj * update latest version of component Signed-off-by: Yuvraj * wip: added generated kustomize output Signed-off-by: yuvraj * wip: added message input in workflow Signed-off-by: yuvraj * wip: remove release automation from kustomize command Signed-off-by: yuvraj * wip: generate kustomize output Signed-off-by: yuvraj * wip: revert webhook and build kustomize output Signed-off-by: yuvraj * updated release workflow Signed-off-by: yuvraj * fix typo Signed-off-by: yuvraj * Milestone 0.12.0 (#888) * Update Flyte Components Signed-off-by: Flyte-Bot Signed-off-by: Haytham Abuelfutuh * update endtoend to flytekit 0.17 Signed-off-by: wild-endeavor Signed-off-by: Haytham Abuelfutuh * empty changelog Signed-off-by: wild-endeavor Signed-off-by: Haytham Abuelfutuh * Update ChangeLog Signed-off-by: Haytham Abuelfutuh * before pull from flyte-bot-update-releases Signed-off-by: Haytham Abuelfutuh Co-authored-by: EngHabu Co-authored-by: wild-endeavor Co-authored-by: HackMD * Update index.rst (#884) * Update index.rst Add Flyte users to Who's Using Flyte and Meet Flyte. * Update rsts/index.rst Co-authored-by: Ketan Umare <16888709+kumare3@users.noreply.github.com> * Update index.rst Co-authored-by: Ketan Umare <16888709+kumare3@users.noreply.github.com> * Dashboard updates (#886) * Adding additional metrics in Flyteadmin dashboard Signed-off-by: Ketan Umare * Flytepropeller metrics added Signed-off-by: Ketan Umare * updated Signed-off-by: Ketan Umare * updated Signed-off-by: Ketan Umare * Added queue metrics Signed-off-by: Ketan Umare * updated name Signed-off-by: Ketan Umare * Add init container that will pre-create buckets in minio (#905) * Add init container that will pre-create buckets in minio Signed-off-by: Jeev B * move minio tag override to overlay Signed-off-by: Jeev B * Add LF AI & Data Logo to README (#902) * Explaining the state machine used by FlytePropeller and Flyte (#903) * Explaining the state machine used by FlytePropeller and Flyte - this document helps to explain the various states a workflow, node and task transitions through. - TODO add a small table that helps users understand what a state in the UI represents Signed-off-by: Ketan Umare * updated docs (addressed comments) Signed-off-by: Ketan Umare * comments addressed - image for nodes improved Signed-off-by: Ketan Umare * Fix default eks storage config (#907) * Fix default eks storage config Signed-off-by: Haytham Abuelfutuh * kustomize Signed-off-by: Haytham Abuelfutuh * bump Signed-off-by: Haytham Abuelfutuh * Restructured Flyte Docs Signed-off-by: samhita-alla * Added Tutorials in the main section Signed-off-by: Samhita Alla * Docs Restructure Signed-off-by: Samhita Alla * Docs Staging Signed-off-by: Samhita Alla Co-authored-by: Niels Bantilan Co-authored-by: Yuvraj <10830562+evalsocket@users.noreply.github.com> Co-authored-by: Flyte Bot Co-authored-by: EngHabu Co-authored-by: wild-endeavor Co-authored-by: HackMD Co-authored-by: SandraGH5 <80421934+SandraGH5@users.noreply.github.com> Co-authored-by: Ketan Umare <16888709+kumare3@users.noreply.github.com> Co-authored-by: Jeev B Co-authored-by: Haytham Abuelfutuh --- rsts/_static/custom.css | 18 ++++++++++++++++++ rsts/basics.rst | 16 ++++++++++++++++ rsts/basics/deployment_options.rst | 6 +++++- rsts/basics/flyte_cli.rst | 6 +++++- rsts/basics/flyte_ui.rst | 6 +++++- rsts/basics/glossary.rst | 6 +++++- rsts/index.rst | 15 ++++----------- 7 files changed, 58 insertions(+), 15 deletions(-) create mode 100644 rsts/basics.rst diff --git a/rsts/_static/custom.css b/rsts/_static/custom.css index c452c23fa0..a6127d48a3 100644 --- a/rsts/_static/custom.css +++ b/rsts/_static/custom.css @@ -7,6 +7,24 @@ h6 { font-weight: bold; } +.sidebar-tree > :not(p, .current) { + font-weight: lighter; +} + +.sidebar-tree ul:first-child { + font-weight: 250; + font-size: 18px; + border: 1px; + border-radius: 5px; + box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2); + margin: 30px; + padding: 10px; +} + +.sidebar-tree ul:first-child li:not(:last-child) { + margin-bottom: 5px; +} + @media only screen and (min-width: 1200px) { .sidebar-drawer { width: 20em; diff --git a/rsts/basics.rst b/rsts/basics.rst new file mode 100644 index 0000000000..73f5a32a0e --- /dev/null +++ b/rsts/basics.rst @@ -0,0 +1,16 @@ +############# +Basics +############# + +.. CAUTION:: + + Coming soon 🛠 + +.. toctree:: + :caption: Basics + :hidden: + + basics/flyte_ui + basics/flyte_cli + basics/deployment_options + basics/glossary \ No newline at end of file diff --git a/rsts/basics/deployment_options.rst b/rsts/basics/deployment_options.rst index ffbd0e02a5..a9b543d2d6 100644 --- a/rsts/basics/deployment_options.rst +++ b/rsts/basics/deployment_options.rst @@ -1,3 +1,7 @@ ################################## Deployment options (Local & Remote) -################################## \ No newline at end of file +################################## + +.. CAUTION:: + + Coming soon 🛠 \ No newline at end of file diff --git a/rsts/basics/flyte_cli.rst b/rsts/basics/flyte_cli.rst index 64581f8247..8e265f71e3 100644 --- a/rsts/basics/flyte_cli.rst +++ b/rsts/basics/flyte_cli.rst @@ -1,3 +1,7 @@ ############## Flyte CLI -############## \ No newline at end of file +############## + +.. CAUTION:: + + Coming soon 🛠 diff --git a/rsts/basics/flyte_ui.rst b/rsts/basics/flyte_ui.rst index 44ca4705f5..583389c893 100644 --- a/rsts/basics/flyte_ui.rst +++ b/rsts/basics/flyte_ui.rst @@ -1,3 +1,7 @@ ################# Flyte UI -################# \ No newline at end of file +################# + +.. CAUTION:: + + Coming soon 🛠 \ No newline at end of file diff --git a/rsts/basics/glossary.rst b/rsts/basics/glossary.rst index eaeef412de..3c0d92d9a4 100644 --- a/rsts/basics/glossary.rst +++ b/rsts/basics/glossary.rst @@ -5,4 +5,8 @@ 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. \ No newline at end of file + 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. + +.. CAUTION:: + + Coming soon 🛠 \ No newline at end of file diff --git a/rsts/index.rst b/rsts/index.rst index 46615719a0..c98496c27a 100644 --- a/rsts/index.rst +++ b/rsts/index.rst @@ -6,26 +6,19 @@ :hidden: getting_started - Cookbook - Concepts + User Guide + Tutorials + Concepts reference/index community/index -.. toctree:: - :caption: Basics - :hidden: - - basics/flyte_ui - basics/flyte_cli - basics/deployment_options - basics/glossary - .. toctree:: :caption: Concepts :maxdepth: 1 :name: divedeeptoc :hidden: + basics concepts/core concepts/control_plane concepts/execution_time