DOCSP-38361 - Add text to empty pages (#5826) (#5827)

* add text to empty pages * fix Co-authored-by: Mike Woofter <[email protected]>
mongodb · May 28, 2024 · 1c75d72 · 1c75d72
1 parent 2281f0d
commit 1c75d72
Show file tree

Hide file tree

Showing 26 changed files with 109 additions and 1 deletion.
diff --git a/docs/contributing.txt b/docs/contributing.txt
@@ -11,3 +11,11 @@ Contributing
 
   contributing/code-documentation
   contributing/contributing-guidelines
+
+Overview
+--------
+
+Learn how to contribute to the Mongoid repository in the following sections:
+
+- :ref:`Code Documentation <code-documentation>`
+- :ref:`Contributing Guidelines <contributing-guidelines>`
diff --git a/docs/contributing/contributing-guidelines.txt b/docs/contributing/contributing-guidelines.txt
@@ -1,4 +1,4 @@
-.. _contributing-guildelines:
+.. _contributing-guidelines:
 
 ***********************
 Contributing Guidelines

diff --git a/docs/installation-configuration.txt b/docs/installation-configuration.txt
@@ -13,3 +13,13 @@ Installation & Configuration
   reference/compatibility
   reference/configuration
   reference/rails-integration
+
+Overview
+--------
+
+Learn how to install and configure Mongoid in the following sections:
+
+- :ref:`Installation <installation>`
+- :ref:`Compatibility <compatibility>`
+- :ref:`Configuration <configuration>`
+- :ref:`Rails Integration <rails-integration>`
diff --git a/docs/installation.txt b/docs/installation.txt
@@ -1,3 +1,5 @@
+.. _installation:
+
 ************
 Installation
 ************

diff --git a/docs/reference/associations.txt b/docs/reference/associations.txt
@@ -1,3 +1,5 @@
+.. _associations:
+
 ************
 Associations
 ************

diff --git a/docs/reference/collection-configuration.txt b/docs/reference/collection-configuration.txt
@@ -1,3 +1,5 @@
+.. _collection-configuration:
+
 ************************
 Collection Configuration
 ************************

diff --git a/docs/reference/compatibility.txt b/docs/reference/compatibility.txt
@@ -1,3 +1,5 @@
+.. _compatibility:
+
 *************
 Compatibility
 *************

diff --git a/docs/reference/crud.txt b/docs/reference/crud.txt
@@ -1,3 +1,5 @@
+.. _crud:
+
 ***************
 CRUD Operations
 ***************

diff --git a/docs/reference/persistence-configuration.txt b/docs/reference/persistence-configuration.txt
@@ -1,3 +1,5 @@
+.. _persistence:
+
 *************************
 Persistence Configuration
 *************************

diff --git a/docs/reference/queries.txt b/docs/reference/queries.txt
@@ -1,3 +1,5 @@
+.. _queries:
+
 *******
 Queries
 *******

diff --git a/docs/reference/rails-integration.txt b/docs/reference/rails-integration.txt
@@ -1,3 +1,5 @@
+.. _rails-integration:
+
 *****************
 Rails Integration
 *****************

diff --git a/docs/reference/sharding.txt b/docs/reference/sharding.txt
@@ -1,3 +1,5 @@
+.. _sharding:
+
 **********************
 Sharding Configuration
 **********************

diff --git a/docs/reference/validation.txt b/docs/reference/validation.txt
@@ -1,3 +1,5 @@
+.. _validation:
+
 **********
 Validation
 **********

diff --git a/docs/release-notes.txt b/docs/release-notes.txt
@@ -14,3 +14,15 @@ Release Notes
   release-notes/mongoid-7.5
   release-notes/mongoid-7.4
   release-notes/mongoid-7.3
+
+Overview
+--------
+
+See the following sections to learn more about upgrading Mongoid:
+
+- :ref:`Upgrading Mongoid <upgrading>`
+- :ref:`Mongoid 8.1 <mongoid-8.1>`
+- :ref:`Mongoid 8.0 <mongoid-8.0>`
+- :ref:`Mongoid 7.5 <mongoid-7.5>`
+- :ref:`Mongoid 7.4 <mongoid-7.4>`
+- :ref:`Mongoid 7.3 <mongoid-7.3>`
diff --git a/docs/release-notes/mongoid-7.3.txt b/docs/release-notes/mongoid-7.3.txt
@@ -1,3 +1,5 @@
+.. _mongoid-7.3:
+
 ***********
 Mongoid 7.3
 ***********

diff --git a/docs/release-notes/mongoid-7.4.txt b/docs/release-notes/mongoid-7.4.txt
@@ -1,3 +1,5 @@
+.. _mongoid-7.4:
+
 ***********
 Mongoid 7.4
 ***********

diff --git a/docs/release-notes/mongoid-7.5.txt b/docs/release-notes/mongoid-7.5.txt
@@ -1,3 +1,5 @@
+.. _mongoid-7.5:
+
 ***********
 Mongoid 7.5
 ***********

diff --git a/docs/release-notes/mongoid-8.0.txt b/docs/release-notes/mongoid-8.0.txt
@@ -1,3 +1,5 @@
+.. _mongoid-8.0:
+
 ***********
 Mongoid 8.0
 ***********

diff --git a/docs/release-notes/mongoid-8.1.txt b/docs/release-notes/mongoid-8.1.txt
@@ -1,3 +1,5 @@
+.. _mongoid-8.1:
+
 ***********
 Mongoid 8.1
 ***********

diff --git a/docs/schema-configuration.txt b/docs/schema-configuration.txt
@@ -16,3 +16,16 @@ Schema Configuration
   reference/collection-configuration
   reference/indexes
   reference/sharding
+
+Overview
+--------
+
+See the following sections to learn how to configure a schema with Mongoid:
+
+- :ref:`Field Definition <fields>`
+- :ref:`Inheritance <inheritance>`
+- :ref:`Associations <associations>`
+- :ref:`Validation <validation>`
+- :ref:`Collection Configuration <collection-configuration>`
+- :ref:`Index Management <indexes>`
+- :ref:`Sharding Management <sharding>`
diff --git a/docs/tutorials.txt b/docs/tutorials.txt
@@ -14,3 +14,14 @@ Tutorials
   tutorials/getting-started-rails6
   tutorials/documents
   tutorials/common-errors
+
+Overview
+--------
+
+See the following sections to learn more about working with Mongoid:
+
+- :ref:`Getting Started (Sinatra) <getting-started-sinatra>`
+- :ref:`Getting Started (Rails 7) <getting-started-7>`
+- :ref:`Getting Started (Rails 6) <getting-started-6>`
+- :ref:`Documents <documents>`
+- :ref:`Common Errors <common-errors>`
diff --git a/docs/tutorials/common-errors.txt b/docs/tutorials/common-errors.txt
@@ -1,3 +1,5 @@
+.. _common-errors:
+
 *************
 Common Errors
 *************

diff --git a/docs/tutorials/getting-started-rails6.txt b/docs/tutorials/getting-started-rails6.txt
@@ -1,3 +1,5 @@
+.. _getting-started-6:
+
 *************************
 Getting Started (Rails 6)
 *************************

diff --git a/docs/tutorials/getting-started-rails7.txt b/docs/tutorials/getting-started-rails7.txt
@@ -1,3 +1,5 @@
+.. _getting-started-7:
+
 *************************
 Getting Started (Rails 7)
 *************************

diff --git a/docs/tutorials/getting-started-sinatra.txt b/docs/tutorials/getting-started-sinatra.txt
@@ -1,3 +1,5 @@
+.. _getting-started-sinatra:
+
 *************************
 Getting Started (Sinatra)
 *************************

diff --git a/docs/working-with-data.txt b/docs/working-with-data.txt
@@ -19,3 +19,19 @@ Working With Data
   reference/callbacks
   reference/sessions
   reference/transactions
+
+Overview
+--------
+
+See the following sections to learn more about working with data in Mongoid:
+
+- :ref:`CRUD Operations <crud>`
+- :ref:`Queries <queries>`
+- :ref:`Text Search <text-search>`
+- :ref:`Aggregation Pipeline <aggregation-pipeline>`
+- :ref:`Map/Reduce <map-reduce>`
+- :ref:`Persistence Configuration <persistence>`
+- :ref:`Nested Attributes <nested-attributes>`
+- :ref:`Callbacks <callbacks>`
+- :ref:`Sessions <sessions>`
+- :ref:`Transactions <transactions>`
-Original file line number
+Diff line change
@@ -1,3 +1,5 @@
+    .. _queries:
     *******
     Queries
     *******
@@ Expand Down @@