[DOCS] Update Continuous Validation in Welcome (#2596)

deepchecks · Jun 13, 2023 · 867c934 · 867c934
1 parent e22250e
commit 867c934
Show file tree

Hide file tree

Showing 22 changed files with 124 additions and 83 deletions.
diff --git a/docs/source/_static/images/general/deepchecks-testing-logo.svg b/docs/source/_static/images/general/deepchecks-testing-logo.svg
diff --git a/docs/source/_static/images/general/model-evaluation-suite.gif b/docs/source/_static/images/general/model-evaluation-suite.gif
diff --git a/docs/source/_static/images/general/nlp-checks.gif b/docs/source/_static/images/general/nlp-checks.gif
diff --git a/docs/source/_static/images/welcome/ci_cd_title.png b/docs/source/_static/images/welcome/ci_cd_title.png
diff --git a/docs/source/_static/images/welcome/ci_tile.png b/docs/source/_static/images/welcome/ci_tile.png
diff --git a/docs/source/_static/images/welcome/deepchecks_continuous_validation_light.png b/docs/source/_static/images/welcome/deepchecks_continuous_validation_light.png
diff --git a/docs/source/_static/images/welcome/monitoring_tile.png b/docs/source/_static/images/welcome/monitoring_tile.png
diff --git a/docs/source/_static/images/welcome/monitoring_title.png b/docs/source/_static/images/welcome/monitoring_title.png
diff --git a/docs/source/_static/images/welcome/research_title.png b/docs/source/_static/images/welcome/research_title.png
diff --git a/docs/source/_static/images/welcome/testing_phases_in_pipeline.png b/docs/source/_static/images/welcome/testing_phases_in_pipeline.png
diff --git a/docs/source/_static/images/welcome/testing_phases_in_pipeline_with_tiles.png b/docs/source/_static/images/welcome/testing_phases_in_pipeline_with_tiles.png
diff --git a/docs/source/_static/images/welcome/testing_tile.png b/docs/source/_static/images/welcome/testing_tile.png
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -443,7 +443,7 @@ def linkcode_resolve(domain, info):
 
 # Path to logo and favicon
 #
-html_logo = "./_static/images/general/deepchecks_logo.svg"
+html_logo = "./_static/images/general/deepchecks-testing-logo.svg"
 html_favicon = "./_static/favicons/favicon.ico"
 
 # If true, the reST sources are included in the HTML build as _sources/name. The default is True.
@@ -466,6 +466,10 @@ def linkcode_resolve(domain, info):
         "version_match": version,
         "url_template": "https://docs.deepchecks.com/{version}/",
     },
+    "external_links": [
+      {"name": "Monitoring", "url": "https://docs.deepchecks.com/monitoring"},
+      {"name": "CI", "url": "https://docs.deepchecks.com/stable/general/usage/ci_cd.html"}
+    ],
     "icon_links": [
         {
             "name": "GitHub",
@@ -474,7 +478,7 @@ def linkcode_resolve(domain, info):
         },
         {
             "name": "Slack",
-            "url": "https://deepcheckscommunity.slack.com/join/shared_invite/zt-y28sjt1v-PBT50S3uoyWui_Deg5L_jg#/shared-invite/email",
+            "url": "https://deepchecks.com/slack",
             "icon": "fab fa-slack",
         },
         {

diff --git a/docs/source/general/concepts/when_should_you_use.rst b/docs/source/general/concepts/when_should_you_use.rst
@@ -23,7 +23,7 @@ Built-In Suites - API Reference
 
 Check the :mod:`deepchecks.tabular.suites` in the API reference for a list of all of the built-in suites for tabular data,
 :mod:`deepchecks.nlp.suites` for nlp data or
-:mod:`deepchecks.vision.suites` for vision data (in beta release).
+:mod:`deepchecks.vision.suites` for vision data.
 .
 
 

diff --git a/docs/source/general/index.rst b/docs/source/general/index.rst
@@ -6,6 +6,10 @@ General
 
 Here you can find the key concepts, structure, recommended flow, and dive in to many of the deepchecks functionalities.
 
+.. image:: /_static/images/general/checks-and-conditions.png
+   :alt: Deepchecks Testing Suite of Checks
+   :width: 50%
+   :align: center
 
 Concepts
 --------

diff --git a/docs/source/general/usage/ci_cd.rst b/docs/source/general/usage/ci_cd.rst
@@ -1,3 +1,5 @@
+.. _using_deepchecks_ci_cd:
+
 =================================
 Using Deepchecks In CI/CD
 =================================

diff --git a/docs/source/general/usage/showing_results.rst b/docs/source/general/usage/showing_results.rst
@@ -10,8 +10,10 @@ refer to the :ref:`exporting_deepchecks_results` guide.
 Structure:
 
 - :ref:`showing_results_main_methods`
-   - :ref:`show_method`
-   - :ref:`show_in_window_method`
+
+  - :ref:`show_method`
+  - :ref:`show_in_window_method`
+
 - :ref:`alternative_show_options_for_troubleshooting`
 
 

diff --git a/docs/source/getting-started/installation.rst b/docs/source/getting-started/installation.rst
@@ -66,11 +66,6 @@ Simply run the following command in a notebook cell
 Deepchecks For NLP
 ==================
 
-.. note:: 
-   Deepchecks' NLP subpackage is in **beta** release, and is available from PyPI,
-   use at your own discretion. `Github Issues <https://github.com/deepchecks/deepchecks/issues>`__ are
-   highly encouraged for feature requests and bug reports.
-
 Installation of deepchecks for NLP should be stated explicitly and it includes
 both the installation of the tabular version and of the nlp subpackage.
 Example commands from above should be altered to install `deepchecks[nlp]`.
@@ -87,11 +82,6 @@ Using Pip
 Deepchecks For Computer Vision
 ===============================
 
-.. note::
-   Deepchecks' Computer Vision subpackage is in **beta** release, and is available from PyPI,
-   use at your own discretion. `Github Issues <https://github.com/deepchecks/deepchecks/issues>`__ are
-   highly encouraged for feature requests and bug reports.
-
 Installation of deepchecks for CV should be stated explicitly and it includes
 both the installation of the tabular version and of the computer vision subpackage.
 Example commands from above should be altered to install `deepchecks[vision]`.