docs: cleanup unused docs (#440)

# The problem While searching for some docs, Ive found bunch of pages that are redundant unused or outdated # This PR's solution Clean up docs a little bit # Checklist _Check that this PR satisfies the following items:_ - [x] Tests have been added for new features/changed behavior (if no new features have been added, check the box). - [ ] The [changelog file](CHANGELOG.md) has been updated with a user-readable description of the changes (if the change isn't visible to the user in any way, check the box). - [x] The PR's title is prefixed with `<feat/fix/chore/imp[rovement]/int[ernal]/docs>[!]:` - [x] The PR is linked to a JIRA ticket (if there's no suitable ticket, check the box). --------- Co-authored-by: Alexander Juda <[email protected]>
zapata-engineering · Aug 20, 2024 · b1e7275 · b1e7275
1 parent 3cefd46
commit b1e7275
Show file tree

Hide file tree

Showing 17 changed files with 13 additions and 403 deletions.
diff --git a/.gitignore b/.gitignore
@@ -58,7 +58,7 @@ nosetests.xml
 .scrapy
 
 # Sphinx documentation
-docs/_build/
+projects/orquestra-sdk/docs/_build
 
 # PyBuilder
 target/

diff --git a/projects/orquestra-sdk/docs/conf.py b/projects/orquestra-sdk/docs/conf.py
@@ -13,7 +13,7 @@
 # -- Project information -----------------------------------------------------
 
 project = "Orquestra Workflow SDK"
-copyright = "2023, Zapata Computing, Inc"
+copyright = "2024, Zapata Computing, Inc"
 author = "your friends at Zapata"
 
 # The full version, including alpha/beta/rc tags

diff --git a/projects/orquestra-sdk/docs/guides/index.rst b/projects/orquestra-sdk/docs/guides/index.rst
@@ -13,5 +13,4 @@ Guides
     resource-management
     version-compatibility
     mlflow
-    migrating-from-quantum-engine
     workspaces-and-projects
diff --git a/projects/orquestra-sdk/docs/guides/migrating-from-quantum-engine.rst b/projects/orquestra-sdk/docs/guides/migrating-from-quantum-engine.rst
diff --git a/projects/orquestra-sdk/docs/index.rst b/projects/orquestra-sdk/docs/index.rst
@@ -23,19 +23,18 @@ Quick Reference
 
       A guide of dos and don'ts when writing ``@workflow`` and ``@task`` functions.
 
-   .. grid-item-card:: CLI Reference
-      :link: quickref/cli-reference
+   .. grid-item-card:: CLI guide
+      :link: tutorials/cli-beginners-guide
       :link-type: doc
 
-      Documentation for the ``orq`` command-line interface.
+      Short introduction for the ``orq`` command-line interface.
 
 .. toctree::
    :maxdepth: 2
    :hidden:
 
    tutorials/index
    guides/index
-   quickref/index
 
 
 Last change: |today|
diff --git a/projects/orquestra-sdk/docs/quickref/cli-reference.rst b/projects/orquestra-sdk/docs/quickref/cli-reference.rst
diff --git a/projects/orquestra-sdk/docs/quickref/index.rst b/projects/orquestra-sdk/docs/quickref/index.rst
diff --git a/projects/orquestra-sdk/docs/tutorials/cli-beginners-guide.rst b/projects/orquestra-sdk/docs/tutorials/cli-beginners-guide.rst
@@ -11,7 +11,7 @@ The Beginner's Guide to the Orquestra CLI
 
         orq -V
 
-    For installation instructions, see :doc:`Installing<installing-macos-linux>` or :doc:`Installing on Windows <installing-windows>`.
+    For installation instructions, see :doc:`Installing<installing-macos-linux>`.
 
 Creating a Workflow Definition
 ==============================

diff --git a/projects/orquestra-sdk/docs/tutorials/index.rst b/projects/orquestra-sdk/docs/tutorials/index.rst
@@ -9,7 +9,6 @@ After going through these tutorials, you will be able to build workflows and man
     :maxdepth: 1
 
     installing-macos-linux
-    installing-windows
     cli-beginners-guide
     quickstart
     ray