DOCSP-46121: cleanup

.github/workflows/copy-compat-to-docs-shared.yml

@@ -0,0 +1,80 @@
+name: Copy Files to docs-shared
+
+on:
+  workflow_dispatch: {} # use to manually trigger workflow
+  push:
+    branches:
+      - "master"
+    paths:
+      - "source/includes/mongodb-compatibility-table-mongoid.rst"
+      - "source/includes/language-compatibility-table-mongoid.rst"
+      - "source/includes/rails-compatibility-table-mongoid.rst"
+      - "source/includes/ror-compatibility-table-mongoid.rst"
+      - "source/includes/ruby-driver-compatibility-table-mongoid.rst"
+
+jobs:
+  copy-file:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Copy mongodb-compat table
+        uses: dmnemec/copy_file_to_another_repo_action@main
+        env:
+          API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
+        with:
+          source_file: "source/includes/mongodb-compatibility-table-mongoid.rst"
+          destination_repo: "10gen/docs-shared"
+          destination_folder: "dbx"
+          user_email: "[email protected]"
+          user_name: "docs-builder-bot"
+          commit_message: "Auto-import from docs-mongoid"
+
+      - name: Copy language-compat table
+        uses: dmnemec/copy_file_to_another_repo_action@main
+        env:
+          API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
+        with:
+          source_file: "source/includes/language-compatibility-table-mongoid.rst"
+          destination_repo: "10gen/docs-shared"
+          destination_folder: "dbx"
+          user_email: "[email protected]"
+          user_name: "docs-builder-bot"
+          commit_message: "Auto-import from docs-mongoid"
+
+      - name: Copy ruby-on-rails-compat table
+        uses: dmnemec/copy_file_to_another_repo_action@main
+        env:
+          API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
+        with:
+          source_file: "source/includes/rails-compatibility-table-mongoid.rst"
+          destination_repo: "10gen/docs-shared"
+          destination_folder: "dbx"
+          user_email: "[email protected]"
+          user_name: "docs-builder-bot"
+          commit_message: "Auto-import from docs-mongoid"
+
+      - name: Copy rails-feature-compat table
+        uses: dmnemec/copy_file_to_another_repo_action@main
+        env:
+          API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
+        with:
+          source_file: "source/includes/ror-compatibility-table-mongoid.rst"
+          destination_repo: "10gen/docs-shared"
+          destination_folder: "dbx"
+          user_email: "[email protected]"
+          user_name: "docs-builder-bot"
+          commit_message: "Auto-import from docs-mongoid"
+
+      - name: Copy ruby-driver-compat table
+        uses: dmnemec/copy_file_to_another_repo_action@main
+        env:
+          API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
+        with:
+          source_file: "source/includes/ruby-driver-compatibility-table-mongoid.rst"
+          destination_repo: "10gen/docs-shared"
+          destination_folder: "dbx"
+          user_email: "[email protected]"
+          user_name: "docs-builder-bot"
+          commit_message: "Auto-import from docs-mongoid"

config/redirects

@@ -1,10 +1,72 @@
 define: prefix docs/mongoid
-define: base https://www.mongodb.com/docs/mongoid
-define: versions 8.1 upcoming
+define: base https://www.mongodb.com/${prefix}
+define: versions v9.0 master
 
-symlink: current -> 8.1
+symlink: current -> v9.0
+symlink: upcoming -> master
 
 raw: ${prefix}/ -> ${base}/current/
-raw: ${prefix}/master -> ${base}/upcoming/
+raw: ${prefix}/stable -> ${base}/current/
 
-raw: ${prefix}/current/release-notes/mongoid-7.0 -> ${base}/current/
+# Redirects for standardized (new) page URLs in old docs
+[*-v9.0]: ${prefix}/${version}/compatibility/ -> ${base}/${version}/reference/compatibility/ 
+[*-v9.0]: ${prefix}/${version}/configuration/ -> ${base}/${version}/reference/configuration/
+[*-v9.0]: ${prefix}/${version}/integrations-tools/rails-integration/ -> ${base}/${version}/reference/rails-integration/
+[*-v9.0]: ${prefix}/${version}/quick-start-sinatra/ -> ${base}/${version}/tutorials/getting-started-sinatra/
+[*-v9.0]: ${prefix}/${version}/quick-start-rails/ -> ${base}/${version}/tutorials/getting-started-rails7/
+[*-v9.0]: ${prefix}/${version}/data-modeling/documents/ -> ${base}/${version}/tutorials/documents/
+[*-v9.0]: ${prefix}/${version}/security/encryption/ -> ${base}/${version}/tutorials/automatic-encryption/
+[*-v9.0]: ${prefix}/${version}/data-modeling/field-types/ -> ${base}/${version}/reference/fields/
+[*-v9.0]: ${prefix}/${version}/data-modeling/inheritance/ -> ${base}/${version}/reference/inheritance/
+[*-v9.0]: ${prefix}/${version}/data-modeling/associations/ -> ${base}/${version}/reference/associations/
+[*-v9.0]: ${prefix}/${version}/data-modeling/validation/ -> ${base}/${version}/reference/validation/
+[*-v9.0]: ${prefix}/${version}/configuration/collection-config/ -> ${base}/${version}/reference/collection-configuration/
+[*-v9.0]: ${prefix}/${version}/data-modeling/indexes/ -> ${base}/${version}/reference/indexes/
+[*-v9.0]: ${prefix}/${version}/configuration/sharding/ -> ${base}/${version}/reference/sharding/
+[*-v9.0]: ${prefix}/${version}/interact-data/crud/ -> ${base}/${version}/reference/crud/
+[*-v9.0]: ${prefix}/${version}/interact-data/specify-query/ -> ${base}/${version}/reference/queries/
+[*-v9.0]: ${prefix}/${version}/interact-data/text-search/ -> ${base}/${version}/reference/text-search/
+[*-v9.0]: ${prefix}/${version}/interact-data/aggregation/ -> ${base}/${version}/reference/aggregation/
+[*-v9.0]: ${prefix}/${version}/configuration/persistence-config/ -> ${base}/${version}/reference/persistence-configuration/
+[*-v9.0]: ${prefix}/${version}/interact-data/nested-attributes/ -> ${base}/${version}/reference/nested-attributes/
+[*-v9.0]: ${prefix}/${version}/data-modeling/callbacks/ -> ${base}/${version}/reference/callbacks/
+[*-v9.0]: ${prefix}/${version}/interact-data/transaction/ -> ${base}/${version}/reference/transactions/
+[*-v9.0]: ${prefix}/${version}/whats-new/ -> ${base}/${version}/release-notes/mongoid-9.0/
+[*-v9.0]: ${prefix}/${version}/code-documentation/ -> ${base}/${version}/contributing/code-documentation/
+[*-v9.0]: ${prefix}/${version}/issues-and-help/ -> ${base}/${version}/contributing/contributing-guidelines/
+[*-v9.0]: ${prefix}/${version}/integrations-tools/external-resources/ -> ${base}/${version}/ecosystem/
+
+# Redirects for old page URLs in standardized (new) docs
+[master]: ${prefix}/${version}/installation/ -> ${base}/${version}/#quick-start
+[master]: ${prefix}/${version}/reference/compatibility/ -> ${base}/${version}/compatibility/
+[master]: ${prefix}/${version}/reference/configuration/ -> ${base}/${version}/configuration/
+[master]: ${prefix}/${version}/reference/rails-integration/ -> ${base}/${version}/integrations-tools/rails-integration/
+[master]: ${prefix}/${version}/tutorials/getting-started-sinatra/ -> ${base}/${version}/quick-start-sinatra/
+[master]: ${prefix}/${version}/tutorials/getting-started-rails7/ -> ${base}/${version}/quick-start-rails/
+[master]: ${prefix}/${version}/tutorials/getting-started-rails6/ -> ${base}/${version}/quick-start-rails/
+[master]: ${prefix}/${version}/tutorials/documents/ -> ${base}/${version}/data-modeling/documents/
+[master]: ${prefix}/${version}/tutorials/common-errors/ -> ${base}/${version}/
+[master]: ${prefix}/${version}/tutorials/automatic-encryption/ -> ${base}/${version}/security/encryption/
+[master]: ${prefix}/${version}/reference/fields/ -> ${base}/${version}/data-modeling/field-types/
+[master]: ${prefix}/${version}/reference/inheritance/ -> ${base}/${version}/data-modeling/inheritance/
+[master]: ${prefix}/${version}/reference/associations/ -> ${base}/${version}/data-modeling/associations/
+[master]: ${prefix}/${version}/reference/validation/ -> ${base}/${version}/data-modeling/validation/
+[master]: ${prefix}/${version}/reference/collection-configuration/ -> ${base}/${version}/configuration/collection-config/
+[master]: ${prefix}/${version}/reference/indexes/ -> ${base}/${version}/data-modeling/indexes/
+[master]: ${prefix}/${version}/reference/sharding/ -> ${base}/${version}/configuration/sharding/
+[master]: ${prefix}/${version}/reference/crud/ -> ${base}/${version}/interact-data/crud/
+[master]: ${prefix}/${version}/reference/queries/ -> ${base}/${version}/interact-data/specify-query/
+[master]: ${prefix}/${version}/reference/text-search/ -> ${base}/${version}/interact-data/text-search/
+[master]: ${prefix}/${version}/reference/aggregation/ -> ${base}/${version}/interact-data/aggregation/
+[master]: ${prefix}/${version}/reference/map-reduce/ -> ${base}/${version}/interact-data/aggregation/
+[master]: ${prefix}/${version}/reference/persistence-configuration/ -> ${base}/${version}/configuration/persistence-config/
+[master]: ${prefix}/${version}/reference/nested-attributes/ -> ${base}/${version}/interact-data/nested-attributes/
+[master]: ${prefix}/${version}/reference/callbacks/ -> ${base}/${version}/data-modeling/callbacks/
+[master]: ${prefix}/${version}/reference/sessions/ -> ${base}/${version}/interact-data/transaction/
+[master]: ${prefix}/${version}/reference/transactions/ -> ${base}/${version}/interact-data/transaction/
+[master]: ${prefix}/${version}/release-notes/upgrading/ -> ${base}/${version}/whats-new/
+[master]: ${prefix}/${version}/release-notes/mongoid-9.0/ -> ${base}/${version}/whats-new/
+[master]: ${prefix}/${version}/contributing/code-documentation/ -> ${base}/${version}/code-documentation/
+[master]: ${prefix}/${version}/contributing/contributing-guidelines/ -> ${base}/${version}/issues-and-help/
+[master]: ${prefix}/${version}/additional-resources/ -> ${base}/${version}/integrations-tools/external-resources/
+[master]: ${prefix}/${version}/ecosystem/ -> ${base}/${version}/integrations-tools/external-resources/

source/api.txt

@@ -12,4 +12,4 @@ API Documentation
    :maxdepth: 1
 
     {+odm+} <{+api+}>
-    Ruby Driver <{+ruby-api+}>
+    {+language+} Driver <{+ruby-api+}>

source/code-documentation.txt

@@ -198,15 +198,16 @@ Type Declaration
      # @param [ Hash<Symbol, [ true | false ]> ] hash A Hash whose keys are Symbols,
      #   and whose values are boolean values.
 
-- **Ruby Values:** Specific values may be denoted in the type using Ruby syntax.
+- **{+language+} Values:** Specific values may be denoted in the type
+  using {+language+} syntax.
 
   .. code-block:: ruby
 
      # @param [ :before | :after ] timing One of the Symbol values :before or :after.
 
 - **True, False, and Nil:** Use ``true``, ``false``, and ``nil`` rather than
   ``TrueClass``, ``FalseClass``, and ``NilClass``. Do not use ``Boolean`` as a type
-  since it does not exist in Ruby.
+  since it does not exist in {+language+}.
 
   .. code-block:: ruby
 

source/compatibility.txt

@@ -38,7 +38,7 @@ MongoDB Compatibility
 
 The following compatibility table specifies the recommended version or versions
 of {+odm+} that you can use with a specific version of MongoDB. To use
-features of a particular MongoDB Server version, both the
+features of a particular {+mdb-server+} version, both the
 {+ruby-driver+} and {+odm+} must be compatible with that MongoDB
 version. To learn about the driver's MongoDB compatibility details,
 see :ruby:`Compatibility </reference/driver-compatibility/>`

source/configuration/app-config.txt

@@ -331,14 +331,14 @@ functionality is provided by the {+ruby-driver+}, which implements the
 following supported algorithms:
 
 - `Zstandard <https://facebook.github.io/zstd/>`__ (*Recommended*): To use ``zstandard``
-  compression, you must install the  `zstd-ruby
-  <https://rubygems.org/gems/zstd-ruby>`__ library. This compressor
+  compression, you must install the :rubygems:`zstd-ruby
+  <gems/zstd-ruby>` library. This compressor
   produces the highest compression at the same CPU consumption compared
   to the other compressors.
 - :github:`Snappy <google/snappy>`: To use ``snappy`` compression, you
-  must install the  `snappy <https://rubygems.org/gems/snappy>`__ library.
+  must install the :rubygems:`snappy <gems/snappy>` library.
 - `Zlib <https://zlib.net/>`__: To use ``zlib`` compression, you
-  must install the  `zlib <https://rubygems.org/gems/zlib>`__ library.
+  must install the :rubygems:`zlib <gems/zlib>` library.
 
 To use wire protocol compression, configure the driver options
 in your ``mongoid.yml`` file:
@@ -359,4 +359,4 @@ use compression, even if the required dependencies for one or more
 compressors are installed.
 
 The driver chooses the first compressor, if you specify multiple, that
-is supported by the MongoDB Server.
+is supported by the {+mdb-server+}.

source/configuration/collection-config.txt

@@ -29,7 +29,7 @@ Configure Collection Options
 You can specify configuration options for a collection by using the
 ``:collection_options`` argument with the ``store_in``
 macro. The ``:collection_options`` argument accepts any collection option that
-your {+ruby-driver+} and MongoDB server version supports. 
+your {+ruby-driver+} and {+mdb-server+} version supports.
 
 .. note::
 

source/configuration/persistence-config.txt

@@ -30,8 +30,9 @@ the persistence configuration of a model class.
 
 .. note::
 
-   "Client" refers to a host configuration defined under ``clients`` in your
-   ``mongoid.yml`` file. Most applications use a single client named ``default``.
+   The term client refers to a host configuration defined under
+   ``clients`` in your ``mongoid.yml`` file. Most applications use
+   a single client named ``default``.
 
 Default Collection Name
 -----------------------
@@ -48,12 +49,12 @@ the ``Person`` class, the corresponding collection is named ``people``.
 
 However, the default rules of pluralization don't always work. For 
 example, suppose your model is named ``Rey``. The plural form of this word in
-Spanish is "reyes," but the default collection name is "reys."
+Spanish is ``reyes``, but the default collection name is ``reys``.
 
 You can create a new pluralization rule for your model class by calling the
-`ActiveSupport::Inflector::Inflections.plural() <https://api.rubyonrails.org/classes/ActiveSupport/Inflector/Inflections.html#method-i-plural>`__ 
+`ActiveSupport::Inflector::Inflections.plural <https://api.rubyonrails.org/classes/ActiveSupport/Inflector/Inflections.html#method-i-plural>`__ 
 instance method and passing the singular and plural forms of your class name.
-The following example specifies "reyes" as the plural of "rey":
+The following example specifies ``reyes`` as the plural of ``rey``:
 
 .. literalinclude:: /includes/configuration/persistence-configuration.rb
    :language: ruby
@@ -65,8 +66,9 @@ collection.
 
 .. note:: BSON Document Structure
 
-   When {+odm+} stores a document in a database, it serializes the Ruby object
-   to a BSON document that has the following structure:
+   When {+odm+} stores a document in a database, it serializes the
+   {+language+} object to a BSON document that has the following
+   structure:
 
    .. literalinclude:: /includes/configuration/persistence-configuration.rb
       :language: ruby

source/configuration/query-cache-config.txt

@@ -26,6 +26,8 @@ activate the :ref:`mongoid-query-cache` for each request to store your
 query results. This can improve your application speed and efficiency by
 reducing the number of calls your application must make to the database.
 
+.. _mongoid-query-cache-rack:
+
 Enable Query Cache for Rack Web Requests
 ----------------------------------------
 

source/configuration/sharding.txt

@@ -153,7 +153,6 @@ errors, check the output of the {+odm+} logger configured for your application.
    run the :manual:`flushRouterConfig </reference/command/flushRouterConfig/>`
    command on each ``mongos`` node.
 
-
 Additional Information
 ----------------------