]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
quick doc adjustments
authorMike Bayer <mike_mp@zzzcomputing.com>
Thu, 3 Mar 2022 15:33:14 +0000 (10:33 -0500)
committerMike Bayer <mike_mp@zzzcomputing.com>
Thu, 3 Mar 2022 15:41:44 +0000 (10:41 -0500)
tweet thread:  https://twitter.com/zzzeek/status/1499397255089909762

Change-Id: I5556ef707c2285e7b64c91ae5c58af52efcf4770
(cherry picked from commit f68a51c549754637bd59213101025f1ee63e4865)

doc/build/index.rst
doc/build/intro.rst

index 35005872f43233dca93e51f0aac0fbea228111b5..d39f1217a755c1cc35cb5c9de38f2f36450f5cae 100644 (file)
@@ -16,16 +16,11 @@ SQLAlchemy Documentation
 
   .. container::
 
-    A high level view and getting set up.
+    New to SQLAlchemy?   Start here:
 
-    :doc:`Overview <intro>` |
-    :ref:`Installation Guide <installation>` |
-    :doc:`Frequently Asked Questions <faq/index>` |
-    :doc:`Migration from 1.3 <changelog/migration_14>` |
-    :doc:`Glossary <glossary>` |
-    :doc:`Error Messages <errors>` |
-    :doc:`Changelog catalog <changelog/index>`
+    * **For Python Beginners:** :ref:`Installation Guide <installation>` - basic guidance on installing with pip and similar
 
+    * **For Python Veterans:** :doc:`SQLAlchemy Overview <intro>` - brief architectural overview
 
 .. container:: left_right_container
 
@@ -37,20 +32,17 @@ SQLAlchemy Documentation
 
   .. container::
 
-    **SQLAlchemy 1.4 / 2.0 Transitional**
+    **SQLAlchemy 1.4 / 2.0**
 
     SQLAlchemy 2.0 is functionally available as part of SQLAlchemy 1.4, and integrates
     Core and ORM working styles more closely than ever.   The new tutorial introduces
-    both concepts in parallel.  New users and those starting new projects should start here!
-
-    * :doc:`/tutorial/index` - SQLAlchemy 2.0's main tutorial
-
-    * :doc:`Migrating to SQLAlchemy 2.0 <changelog/migration_20>` - Complete background on migrating from 1.3 or 1.4 to 2.0
+    both concepts in parallel.
 
+    * **For all users:** :doc:`/tutorial/index` - The new SQLAlchemy 1.4/2.0 Tutorial
 
   .. container::
 
-    **SQLAlchemy 1.x Releases**
+    **Legacy SQLAlchemy 1.x Tutorials**
 
     The 1.x Object Relational Tutorial and Core Tutorial are the legacy tutorials
     that should be consulted for existing SQLAlchemy codebases.
@@ -60,6 +52,21 @@ SQLAlchemy Documentation
     * :doc:`core/tutorial`
 
 
+.. container:: left_right_container
+
+  .. container:: leftmost
+
+      .. rst-class:: h2
+
+        Migration Notes
+
+  .. container::
+
+    * :doc:`Migration from 1.3 <changelog/migration_14>` - Migration notes for SQLAlchemy Version 1.4
+    * :doc:`SQLAlchemy 2.0 Preview <changelog/migration_20>` - Background on preparing a SQLAlchemy 1.4 application for SQLAlchemy 2.0
+    * :doc:`Changelog catalog <changelog/index>` - Detailed changelogs for all SQLAlchemy Versions
+
+
 .. container:: left_right_container
 
   .. container:: leftmost
@@ -150,3 +157,18 @@ SQLAlchemy Documentation
 
       :doc:`More Dialects ... <dialects/index>`
 
+.. container:: left_right_container
+
+  .. container:: leftmost
+
+      .. rst-class:: h2
+
+        Supplementary
+
+  .. container::
+
+    * :doc:`Frequently Asked Questions <faq/index>` - A collection of common problems and solutions
+    * :doc:`Glossary <glossary>` - Terms used in SQLAlchemy's documentation
+    * :doc:`Error Message Guide <errors>` - Explainations of many SQLAlchemy Errors
+    * :doc:`Complete table of of contents <contents>`
+    * :doc:`Index <index>`
index 01e33df0346927408061438913af6dc8e0836ba6..4f1b64d15b4aa50469e2144c87e90ba075c58f22 100644 (file)
@@ -206,6 +206,12 @@ Python prompt like this:
      >>> sqlalchemy.__version__ # doctest: +SKIP
      1.4.0
 
+Next Steps
+----------
+
+With SQLAlchemy installed, new and old users alike can
+:ref:`Proceed to the SQLAlchemy Tutorial <unified_tutorial>`.
+
 .. _migration:
 
 1.3 to 1.4 Migration