Skip to content

Commit

Permalink
update docs based on revamp RFC (flyteorg#60)
Browse files Browse the repository at this point in the history
* update docs based on revamp RFC

- udpate main nav items
- update toc
- use furo fork

Signed-off-by: cosmicBboy <[email protected]>

* remove custom.css

Signed-off-by: cosmicBboy <[email protected]>
  • Loading branch information
cosmicBboy authored Apr 30, 2021
1 parent 65580de commit 6114a7c
Show file tree
Hide file tree
Showing 13 changed files with 51 additions and 170 deletions.
2 changes: 1 addition & 1 deletion flytectl/doc-requirements.in
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
furo
git+git://github.com/flyteorg/furo@main
readthedocs-sphinx-search
sphinx
sphinx-prompt
Expand Down
6 changes: 3 additions & 3 deletions flytectl/doc-requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
#
alabaster==0.7.12
# via sphinx
babel==2.9.0
babel==2.9.1
# via sphinx
beautifulsoup4==4.9.3
# via
Expand All @@ -21,7 +21,7 @@ css-html-js-minify==2.5.5
# via sphinx-material
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
Expand Down Expand Up @@ -63,7 +63,7 @@ sphinx-material==0.0.32
# via -r doc-requirements.in
sphinx-prompt==1.4.0
# via -r doc-requirements.in
sphinx==3.5.3
sphinx==3.5.4
# via
# -r doc-requirements.in
# furo
Expand Down
91 changes: 0 additions & 91 deletions flytectl/docs/source/_static/custom.css

This file was deleted.

3 changes: 0 additions & 3 deletions flytectl/docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -115,9 +115,6 @@
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
html_css_files = [
"custom.css",
]

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
Expand Down
2 changes: 1 addition & 1 deletion flytectl/docs/source/gen/flytectl_update.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,5 +76,5 @@ SEE ALSO
* :doc:`flytectl_update_launchplan` - Updates launch plan metadata
* :doc:`flytectl_update_project` - Updates project resources
* :doc:`flytectl_update_task` - Updates task metadata
* :doc:`flytectl_update_workflow` - Updates launch plan metadata
* :doc:`flytectl_update_workflow` - Updates workflow metadata

1 change: 0 additions & 1 deletion flytectl/docs/source/gen/flytectl_update_launchplan.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ Synopsis



Updates launchplan metadata.
Following command updates the description on the launchplan.
::

Expand Down
2 changes: 1 addition & 1 deletion flytectl/docs/source/gen/flytectl_update_project.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Synopsis



Updates the project according the flags passed.Allows you to archive or activate a project.
Updates the project according the flags passed. Allows you to archive or activate a project.
Activates project named flytesnacks.
::

Expand Down
5 changes: 2 additions & 3 deletions flytectl/docs/source/gen/flytectl_update_task.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,17 @@ Synopsis



Updates task metadata.
Following command updates the description on the task.
::

flytectl update task -d development -p flytectldemo core.advanced.run_merge_sort.merge --description "Merge sort example"

Archiving task named entity would is not supported and would throw an error.
Archiving task named entity is not supported and would throw an error.
::

flytectl update task -d development -p flytectldemo core.advanced.run_merge_sort.merge --archive

Activating workflow named entity would be a noop as archiving is not possible.
Activating task named entity would be a noop as archiving is not possible.
::

flytectl update task -d development -p flytectldemo core.advanced.run_merge_sort.merge --activate
Expand Down
5 changes: 2 additions & 3 deletions flytectl/docs/source/gen/flytectl_update_workflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,13 @@
flytectl update workflow
------------------------

Updates launch plan metadata
Updates workflow metadata

Synopsis
~~~~~~~~



Updates workflow metadata.
Following command updates the description on the workflow.
::

Expand All @@ -21,7 +20,7 @@ Archiving workflow named entity would cause this to disapper from flyteconsole U

flytectl update workflow -p flytectldemo -d development core.advanced.run_merge_sort.merge_sort --archive

Activating workflow named entity would unarchive it.
Activating workflow named entity
::

flytectl update workflow -p flytectldemo -d development core.advanced.run_merge_sort.merge_sort --activate
Expand Down
47 changes: 8 additions & 39 deletions flytectl/docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,49 +41,18 @@ Basic Configuration
:hidden:

Getting Started <https://docs.flyte.org/en/latest/getting_started.html>
Tutorials <https://flytecookbook.readthedocs.io>
reference/index
User Guide <https://docs.flyte.org/projects/cookbook/en/latest/user_guide.html>
Tutorials <https://docs.flyte.org/projects/cookbook/en/latest/tutorials.html>
Concepts <https://docs.flyte.org/en/latest/concepts/basics.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
:maxdepth: -1
:caption: Flytectl
:hidden:

Install and Configure <self>

.. toctree::
:maxdepth: 1
:caption: Verbs
:hidden:

gen/flytectl_create
gen/flytectl_get
gen/flytectl_update
gen/flytectl_delete
gen/flytectl_register
gen/flytectl_config

.. toctree::
:maxdepth: 1
:caption: Nouns
:hidden:

gen/flytectl_create_project
gen/flytectl_create_execution
gen/flytectl_get_execution
gen/flytectl_get_project
gen/flytectl_get_workflow
gen/flytectl_get_task
gen/flytectl_get_launchplan
gen/flytectl_update_project
gen/flytectl_register_files
gen/flytectl_version
gen/flytectl_config_validate

.. toctree::
:maxdepth: 2
:caption: Contribute
:hidden:

contribute
verbs
nouns
Contribute <https://github.com/flyteorg/flytectl/blob/master/docs/CONTRIBUTING.md>
19 changes: 19 additions & 0 deletions flytectl/docs/source/nouns.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Nouns
------

.. toctree::
:maxdepth: 1
:caption: Nouns
:hidden:

gen/flytectl_create_project
gen/flytectl_create_execution
gen/flytectl_get_execution
gen/flytectl_get_project
gen/flytectl_get_workflow
gen/flytectl_get_task
gen/flytectl_get_launchplan
gen/flytectl_update_project
gen/flytectl_register_files
gen/flytectl_version
gen/flytectl_config_validate
24 changes: 0 additions & 24 deletions flytectl/docs/source/reference/index.rst

This file was deleted.

14 changes: 14 additions & 0 deletions flytectl/docs/source/verbs.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Verbs
------

.. toctree::
:maxdepth: 1
:caption: Verbs
:hidden:

gen/flytectl_create
gen/flytectl_get
gen/flytectl_update
gen/flytectl_delete
gen/flytectl_register
gen/flytectl_config

0 comments on commit 6114a7c

Please sign in to comment.