[GSK-2236] Fixing docs (#1645)

* fixing docs * fixed cicd integration links * from toc to cells * Uniformize all grid with cards * Rework notebook list * Uniformize every card * fixed tutorials cells --------- Co-authored-by: Hartorn <[email protected]>
Giskard-AI · Nov 29, 2023 · bc37b52 · bc37b52
1 parent f075d68
commit bc37b52
Show file tree

Hide file tree

Showing 24 changed files with 502 additions and 326 deletions.
diff --git a/docs/assets/intro/Giskard_Turtle_new_set_FINAL_05.png b/docs/assets/intro/Giskard_Turtle_new_set_FINAL_05.png
diff --git a/docs/community/index.md b/docs/community/index.md
@@ -0,0 +1,30 @@
+# Community
+```{toctree}
+:caption: Community
+:maxdepth: 1
+:hidden:
+
+discord/index
+github/index
+contribution_guidelines/index
+```
+
+:::::{grid} 1 1 2 2
+
+
+::::{grid-item-card} <br/><h3><center>Discord community</center></h3>
+:text-align: center
+:link: discord/index.html
+::::
+
+::::{grid-item-card} <br/><h3><center>Github community</center></h3>
+:text-align: center
+:link: github/index.html
+::::
+
+::::{grid-item-card} <br/><h3><center>Contribute to Giskard</center></h3>
+:text-align: center
+:link: contribution_guidelines/index.html
+::::
+
+:::::
diff --git a/docs/getting_started/quickstart/index.md b/docs/getting_started/quickstart/index.md
@@ -10,23 +10,23 @@ quickstart_tabular
 quickstart_nlp
 ```
 
-::::::{grid} 1 1 2 2
-:gutter: 1
 
-:::::{grid-item}
-:::{card} <h3><center>📚  LLM Quickstart</center></h3>
+:::::{grid} 1 1 2 2
+
+
+::::{grid-item-card} <br/><h3>📚  LLM Quickstart</h3>
+:text-align: center
 :link: quickstart_llm.ipynb
-:::
-:::::
+::::
 
-:::::{grid-item}
-:::{card} <h3><center>📊  Tabular Quickstart</center></h3>
+::::{grid-item-card} <br/><h3>📊  Tabular Quickstart</h3>
+:text-align: center
 :link: quickstart_tabular.ipynb
-:::
-:::::
+::::
 
-:::::{grid-item}
-:::{card} <h3><center>🗣️ NLP Quickstart</center></h3>
+::::{grid-item-card} <br/><h3>🗣️ NLP Quickstart</h3>
+:text-align: center
 :link: quickstart_nlp.ipynb
-:::
+::::
+
 :::::
diff --git a/docs/giskard_hub/index.md b/docs/giskard_hub/index.md
@@ -0,0 +1,48 @@
+# Giskard Hub
+```{toctree}
+:caption: Giskard Hub
+:maxdepth: 1
+:hidden:
+
+installation_hub/index
+upload/index
+write_and_debug_tests/index
+inspect/index
+compare_models/index
+collaborate/index
+```
+
+:::::{grid} 1 1 2 2
+
+
+::::{grid-item-card} <br/><h3>🌐 Install the Giskard Hub</h3>
+:text-align: center
+:link: installation_hub/index.html
+::::
+
+::::{grid-item-card} <br/><h3>⬆️ Log datasets & models in the Hub</h3>
+:text-align: center
+:link: upload/index.html
+::::
+
+::::{grid-item-card} <br/><h3>👨‍🔬 Add domain-specific tests</h3>
+:text-align: center
+:link: write_and_debug_tests/index.html
+::::
+
+::::{grid-item-card} <br/><h3>🧐 Debug your issues</h3>
+:text-align: center
+:link: inspect/index.html
+::::
+
+::::{grid-item-card} <br/><h3>⚖️ Compare models</h3>
+:text-align: center
+:link: compare_models/index.html
+::::
+
+::::{grid-item-card} <br/><h3>🤝 Collaborate to build better models</h3>
+:text-align: center
+:link: collaborate/index.html
+::::
+
+:::::
diff --git a/docs/giskard_hub/installation_hub/index.md b/docs/giskard_hub/installation_hub/index.md
@@ -25,23 +25,22 @@ install_on_prem/index
 install_cloud/index
 ```
 
-::::::{grid} 1 1 2 2
-:gutter: 1
+:::::{grid} 1 1 2 2
 
-:::::{grid-item}
-:::{card} <h3><center>🤗 HuggingFace Spaces</center></h3>
+
+::::{grid-item-card} <br/><h3>🤗 HuggingFace Spaces</h3>
+:text-align: center
 :link: install_hfs/index.html
-:::
-:::::
+::::
 
-:::::{grid-item}
-:::{card} <h3><center>🏠 On-Premise</center></h3>
+::::{grid-item-card} <br/><h3>🏠 On-Premise</h3>
+:text-align: center
 :link: install_on_prem/index.html
-:::
-:::::
+::::
 
-:::::{grid-item}
-:::{card} <h3><center>☁️ Private Cloud</center></h3>
+::::{grid-item-card} <br/><h3>☁️ Private Cloud</h3>
+:text-align: center
 :link: install_cloud/index.html
-:::
-:::::
+::::
+
+:::::
diff --git a/docs/giskard_hub/installation_hub/install_cloud/index.md b/docs/giskard_hub/installation_hub/install_cloud/index.md
@@ -5,13 +5,13 @@
 :caption: Table of Contents
 :maxdepth: 2
 :hidden:
-   
+
 install_aws/index
 install_azure/index
 install_gcp/index
 ```
 
-Private Cloud installation is adapted if you can easily run a **Cloud instance** by your favourite Cloud provider (AWS, GCP or Azure) and want to easily use Giskard collaborative features (collect feedback from business, share results, etc.). Make sure that you have the rights to **open ports** of your Cloud machine because Giskard needs to open a connection with an ML Worker running on your Python environment. 
+Private Cloud installation is adapted if you can easily run a **Cloud instance** by your favourite Cloud provider (AWS, GCP or Azure) and want to easily use Giskard collaborative features (collect feedback from business, share results, etc.). Make sure that you have the rights to **open ports** of your Cloud machine because Giskard needs to open a connection with an ML Worker running on your Python environment.
 
 > For other ways to install the Giskard Hub, check the [Hugging Face Space](../install_hfs/index.md) setup
 > (easy installation) or the [On-premise](../install_on_prem/index.md) installation.
@@ -29,22 +29,19 @@ To know more about the 3 different licenses of the Hub (Trial, Startup and Enter
 
 
 ::::::{grid} 1 1 2 2
-:gutter: 1
 
-:::::{grid-item}
-:::{card} <h3><center>AWS</center></h3>
+
+::::{grid-item-card} <br/><h3>AWS</h3>
+:text-align: center
 :link: install_aws/index.html
-:::
-:::::
+::::
 
-:::::{grid-item}
-:::{card} <h3><center>Azure</center></h3>
+::::{grid-item-card} <br/><h3>Azure</h3>
+:text-align: center
 :link: install_azure/index.html
-:::
-:::::
+::::
 
-:::::{grid-item}
-:::{card} <h3><center>GCP</center></h3>
+::::{grid-item-card} <br/><h3>GCP</h3>
+:text-align: center
 :link: install_gcp/index.html
-:::
-:::::
+::::
diff --git a/docs/index.md b/docs/index.md
@@ -36,21 +36,47 @@ giskard_hub/collaborate/index
 :maxdepth: 1
 :hidden:
 
-tutorials/index
 tutorials/llm_tutorials/index
 tutorials/tabular_tutorials/index
 tutorials/nlp_tutorials/index
 ```
 
 ```{toctree}
-:caption: Knowledge Bank
+:caption: Knowledge
 :maxdepth: 1
 :hidden:
 
 knowledge/llm_vulnerabilities/index
 knowledge/key_vulnerabilities/index
 knowledge/catalogs/index
-reference/index
+```
+
+```{toctree}
+:caption: Integrations
+:maxdepth: 1
+:hidden:
+
+integrations/cicd/index
+integrations/mlflow/index
+integrations/wandb/index
+integrations/dagshub/index
+integrations/huggingface/index
+```
+
+```{toctree}
+:caption: API Reference
+:maxdepth: 1
+:hidden:
+
+cli/index
+reference/models/index
+reference/datasets/index
+reference/scan/index
+reference/tests/index
+reference/slicing-functions/index
+reference/transformation-functions/index
+reference/push/index
+reference/suite/index
 ```
 
 ```{toctree}
@@ -73,49 +99,54 @@ community/contribution_guidelines/index
 
 
 :::::{grid} 1 1 3 3
-:gutter: 0 5
 
-::::{grid-item-card} <h2><center> Getting Started </center></h2>
+::::{grid-item-card} <h3> Getting Started </h3>
 :text-align: center
 :link: getting_started/index.md
 :img-bottom: assets/intro/coffee.png
 ::::
 
-::::{grid-item-card} <h2><center> Open-Source Library </center></h2>
+::::{grid-item-card} <h3> Open-Source Library </h3>
 :text-align: center
-:link: open_source/installation_library/index.md
+:link: open_source/index.rst
 :img-bottom: assets/intro/ninja.png
 ::::
 
-::::{grid-item-card} <h2><center> Giskard Hub </center></h2>
+::::{grid-item-card} <h3> Giskard Hub </h3>
 :text-align: center
-:link: giskard_hub/installation_hub/index.md
+:link: giskard_hub/index.rst
 :img-bottom: assets/intro/Giskard_Turtle_SK8.png
 ::::
 
-::::{grid-item-card} <h2><center> Tutorials </center></h2>
+::::{grid-item-card} <h3> Tutorials </h3>
 :text-align: center
 :link: tutorials/index.md
 :img-bottom: assets/intro/test_turtle.png
 ::::
 
-::::{grid-item-card} <h2><center> Knowledge </center></h2>
+::::{grid-item-card} <h3> Knowledge </h3>
 :text-align: center
-:link: knowledge/llm_vulnerabilities/index.md
-:img-bottom: assets/intro/integrations.png
+:link: knowledge/index.rst
+:img-bottom: assets/intro/Giskard_Turtle_new_set_FINAL_05.png
 ::::
 
-::::{grid-item-card} <h2><center> Integrations </center></h2>
+::::{grid-item-card} <h3> Integrations </h3>
 :text-align: center
-:link: ./open_source/integrate_tests/index.md
+:link: integrations/index.rst
 :img-bottom: assets/intro/hey.png
 ::::
 
-::::{grid-item-card} <h2><center> API Reference </center></h2>
+::::{grid-item-card} <h3> API Reference </h3>
 :text-align: center
 :link: reference/index.rst
 :img-bottom: assets/intro/Giskard_Turtle_Computer.png
 ::::
 
+::::{grid-item-card} <h3> Community </h3>
+:text-align: center
+:link: community/index.rst
+:img-bottom: assets/intro/integrations.png
+::::
+
 :::::
 
diff --git a/docs/integrations/cicd/index.md b/docs/integrations/cicd/index.md
@@ -1,6 +1,15 @@
 # 🐙️ GitHub
 **Adding Giskard to your CI/CD pipeline will allow you to run the test or scan on every commit to your repository, ensuring
 new models are not introducing new vulnerabilities.**
+
+```{toctree}
+:caption: Table of Contents
+:maxdepth: 1
+:hidden:
+
+./pipeline.ipynb
+```
+
 <br><br>
 :::{warning}
 First, you'll need to know how to run Giskard's scan function
@@ -49,10 +58,11 @@ else:
 
 ## Notebook examples
 ::::::{grid} 1 1 2 2
-:gutter: 1
 
-:::::{grid-item}
-:::{card} <br><h3><center>📊 Tabular</center></h3>
+
+::::{grid-item-card} <br/><h3>📊 Tabular</h3>
+:text-align: center
 :link: pipeline.ipynb
-:::
-:::::
+::::
+
+::::::