[Docs] Rewrite run methods and deployment docs (#945)

Co-authored-by: Antony Milne <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Antony Milne <[email protected]> Co-authored-by: Maximilian Schulz <[email protected]> Co-authored-by: Maximilian Schulz <[email protected]> Co-authored-by: Liam Connors <[email protected]>
mckinsey · Feb 7, 2025 · 07a12da · 07a12da
1 parent 985d15e
commit 07a12da
Show file tree

Hide file tree

Showing 10 changed files with 343 additions and 176 deletions.
diff --git a/...o-core/docs/assets/user_guides/run_deploy/hugging_face_duplicate_this_space.png b/...o-core/docs/assets/user_guides/run_deploy/hugging_face_duplicate_this_space.png
diff --git a/vizro-core/docs/assets/user_guides/run_deploy/hugging_face_edit_app.png b/vizro-core/docs/assets/user_guides/run_deploy/hugging_face_edit_app.png
diff --git a/vizro-core/docs/assets/user_guides/run_deploy/hugging_face_space.png b/vizro-core/docs/assets/user_guides/run_deploy/hugging_face_space.png
diff --git a/.../assets/user_guides/run/pycafe_editor.png → .../user_guides/run_deploy/pycafe_editor.png b/.../assets/user_guides/run/pycafe_editor.png → .../user_guides/run_deploy/pycafe_editor.png
diff --git a/vizro-core/docs/assets/user_guides/run_deploy/pycafe_editor_share.png b/vizro-core/docs/assets/user_guides/run_deploy/pycafe_editor_share.png
diff --git a/vizro-core/docs/pages/user-guides/data.md b/vizro-core/docs/pages/user-guides/data.md
@@ -222,7 +222,7 @@ data_manager.cache = Cache(config={"CACHE_TYPE": "SimpleCache", "CACHE_DEFAULT_T
 ```
 
 !!! warning
-    Simple cache exists purely for single-process development purposes and is not intended to be used in production. If you deploy with multiple workers, [for example with Gunicorn](run.md/#gunicorn), then you should use a production-ready cache backend. All of Flask-Caching's [built-in backends](https://flask-caching.readthedocs.io/en/latest/#built-in-cache-backends) other than `SimpleCache` are suitable for production. In particular, you might like to use [`FileSystemCache`](https://cachelib.readthedocs.io/en/stable/file/) or [`RedisCache`](https://cachelib.readthedocs.io/en/stable/redis/):
+    Simple cache exists purely for single-process development purposes and is not intended to be used in production. If you deploy with multiple workers, [for example with Gunicorn](run-deploy.md/#gunicorn), then you should use a production-ready cache backend. All of Flask-Caching's [built-in backends](https://flask-caching.readthedocs.io/en/latest/#built-in-cache-backends) other than `SimpleCache` are suitable for production. In particular, you might like to use [`FileSystemCache`](https://cachelib.readthedocs.io/en/stable/file/) or [`RedisCache`](https://cachelib.readthedocs.io/en/stable/redis/):
 
     ```py title="Production-ready caches"
     # Store cached data in CACHE_DIR

diff --git a/vizro-core/docs/pages/user-guides/run-deploy.md b/vizro-core/docs/pages/user-guides/run-deploy.md
diff --git a/vizro-core/docs/pages/user-guides/run.md b/vizro-core/docs/pages/user-guides/run.md
diff --git a/vizro-core/hatch.toml b/vizro-core/hatch.toml
@@ -100,7 +100,7 @@ installer = "uv"
 build = "mkdocs build --strict"
 # Disable warnings on the linkcheck so that HTTP redirects are accepted. We could ignore only that warning and specify
 # more advanced settings using a linkcheckerrc config file.
-link-check = "linkchecker site --check-extern --no-warnings --ignore=404.html --ignore-url=127.0.0.1 --ignore-url=https://vizro.readthedocs.io/"
+link-check = "linkchecker site --check-extern --no-warnings --ignore=404.html --ignore-url=127.0.0.1 --ignore-url=https://vizro.readthedocs.io/ --ignore-url=https://platform.ploomber.io/register --ignore-url=https://huggingface.co/join"
 pip = '"{env:HATCH_UV}" pip {args}'
 serve = "mkdocs serve --open"
 

diff --git a/vizro-core/mkdocs.yml b/vizro-core/mkdocs.yml
@@ -10,7 +10,7 @@ nav:
           - Install Vizro: pages/user-guides/install.md
           - Dashboards: pages/user-guides/dashboard.md
           - Pages: pages/user-guides/pages.md
-          - Run methods: pages/user-guides/run.md
+          - Run or deploy dashboards: pages/user-guides/run-deploy.md
       - COMPONENTS:
           - Overview: pages/user-guides/components.md
           - Graphs: pages/user-guides/graph.md