📝 Deprecate old tutorials: Peewee, Couchbase, encode/databases (#10979)

tiangolo · Jan 16, 2024 · 950d9ce · 950d9ce
1 parent d761a29
commit 950d9ce
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 6 deletions.
diff --git a/docs/en/docs/how-to/async-sql-encode-databases.md b/docs/en/docs/how-to/async-sql-encode-databases.md
@@ -1,4 +1,4 @@
-# Async SQL (Relational) Databases with Encode/Databases
+# ~~Async SQL (Relational) Databases with Encode/Databases~~ (deprecated)
 
 !!! info
     These docs are about to be updated. 🎉
@@ -7,6 +7,9 @@
 
     The new docs will include Pydantic v2 and will use <a href="https://sqlmodel.tiangolo.com/" class="external-link" target="_blank">SQLModel</a> once it is updated to use Pydantic v2 as well.
 
+!!! warning "Deprecated"
+    This tutorial is deprecated and will be removed in a future version.
+
 You can also use <a href="https://github.com/encode/databases" class="external-link" target="_blank">`encode/databases`</a> with **FastAPI** to connect to databases using `async` and `await`.
 
 It is compatible with:

diff --git a/docs/en/docs/how-to/nosql-databases-couchbase.md b/docs/en/docs/how-to/nosql-databases-couchbase.md
@@ -1,4 +1,4 @@
-# NoSQL (Distributed / Big Data) Databases with Couchbase
+# ~~NoSQL (Distributed / Big Data) Databases with Couchbase~~ (deprecated)
 
 !!! info
     These docs are about to be updated. 🎉
@@ -7,6 +7,9 @@
 
     The new docs will hopefully use Pydantic v2 and will use <a href="https://art049.github.io/odmantic/" class="external-link" target="_blank">ODMantic</a> with MongoDB.
 
+!!! warning "Deprecated"
+    This tutorial is deprecated and will be removed in a future version.
+
 **FastAPI** can also be integrated with any <abbr title="Distributed database (Big Data), also 'Not Only SQL'">NoSQL</abbr>.
 
 Here we'll see an example using **<a href="https://www.couchbase.com/" class="external-link" target="_blank">Couchbase</a>**, a <abbr title="Document here refers to a JSON object (a dict), with keys and values, and those values can also be other JSON objects, arrays (lists), numbers, strings, booleans, etc.">document</abbr> based NoSQL database.

diff --git a/docs/en/docs/how-to/sql-databases-peewee.md b/docs/en/docs/how-to/sql-databases-peewee.md
@@ -1,4 +1,7 @@
-# SQL (Relational) Databases with Peewee
+# ~~SQL (Relational) Databases with Peewee~~ (deprecated)
+
+!!! warning "Deprecated"
+    This tutorial is deprecated and will be removed in a future version.
 
 !!! warning
     If you are just starting, the tutorial [SQL (Relational) Databases](../tutorial/sql-databases.md){.internal-link target=_blank} that uses SQLAlchemy should be enough.

diff --git a/docs/en/mkdocs.yml b/docs/en/mkdocs.yml
@@ -174,16 +174,16 @@ nav:
   - How To - Recipes:
     - how-to/index.md
     - how-to/general.md
-    - how-to/sql-databases-peewee.md
-    - how-to/async-sql-encode-databases.md
-    - how-to/nosql-databases-couchbase.md
     - how-to/graphql.md
     - how-to/custom-request-and-route.md
     - how-to/conditional-openapi.md
     - how-to/extending-openapi.md
     - how-to/separate-openapi-schemas.md
     - how-to/custom-docs-ui-assets.md
     - how-to/configure-swagger-ui.md
+    - how-to/sql-databases-peewee.md
+    - how-to/async-sql-encode-databases.md
+    - how-to/nosql-databases-couchbase.md
 - Reference (Code API):
   - reference/index.md
   - reference/fastapi.md
@@ -242,6 +242,7 @@ markdown_extensions:
       format: !!python/name:pymdownx.superfences.fence_code_format ''
   pymdownx.tabbed:
     alternate_style: true
+  pymdownx.tilde:
   attr_list: null
   md_in_html: null
 extra: