diff --git a/config/intersphinx.yaml b/config/intersphinx.yaml deleted file mode 100644 index 00a86346..00000000 --- a/config/intersphinx.yaml +++ /dev/null @@ -1,13 +0,0 @@ -# Weirdly, giza wants a non-empty list of two or more, so we have to include extraneous/unused one --hence the python -name: python -url: https://docs.python.org/2/ -path: python2.inv ---- -name: mongodb -url: https://www.mongodb.com/docs/manual/ -path: mongodb.inv ---- -name: driver -url: https://www.mongodb.com/docs/ruby-driver/master/ -path: driver.inv -... diff --git a/config/redirects b/config/redirects index 86e78d16..a7a34fe6 100644 --- a/config/redirects +++ b/config/redirects @@ -9,8 +9,11 @@ raw: ${prefix}/ -> ${base}/current/ raw: ${prefix}/stable -> ${base}/current/ raw: ${prefix}/master -> ${base}/upcoming/ +# General redirects +[v9.0-*]: ${prefix}/${version}/whats-new/ -> ${base}/${version}/reference/release-notes/ +[v9.0-*]: ${prefix}/${version}/compatibility/ -> ${base}/${version}/reference/compatibility/ + # Redirects for standardized (new) page URLs in old docs -[*-v8.1]: ${prefix}/${version}/compatibility/ -> ${base}/${version}/reference/compatibility/ [*-v8.1]: ${prefix}/${version}/configuration/ -> ${base}/${version}/reference/configuration/ [*-v8.1]: ${prefix}/${version}/integrations-tools/rails-integration/ -> ${base}/${version}/reference/rails-integration/ [*-v8.1]: ${prefix}/${version}/quick-start-sinatra/ -> ${base}/${version}/tutorials/getting-started-sinatra/ @@ -32,14 +35,13 @@ raw: ${prefix}/master -> ${base}/upcoming/ [*-v8.1]: ${prefix}/${version}/interact-data/nested-attributes/ -> ${base}/${version}/reference/nested-attributes/ [*-v8.1]: ${prefix}/${version}/data-modeling/callbacks/ -> ${base}/${version}/reference/callbacks/ [*-v8.1]: ${prefix}/${version}/interact-data/transaction/ -> ${base}/${version}/reference/transactions/ -[*-v8.1]: ${prefix}/${version}/whats-new/ -> ${base}/${version}/release-notes/mongoid-9.0/ +[*-v8.1]: ${prefix}/${version}/reference/release-notes/ -> ${base}/${version}/release-notes/mongoid-9.0/ [*-v8.1]: ${prefix}/${version}/code-documentation/ -> ${base}/${version}/contributing/code-documentation/ [*-v8.1]: ${prefix}/${version}/issues-and-help/ -> ${base}/${version}/contributing/contributing-guidelines/ [*-v8.1]: ${prefix}/${version}/integrations-tools/external-resources/ -> ${base}/${version}/ecosystem/ # Redirects for old page URLs in standardized (new) docs [v9.0-*]: ${prefix}/${version}/installation/ -> ${base}/${version}/#quick-start -[v9.0-*]: ${prefix}/${version}/reference/compatibility/ -> ${base}/${version}/compatibility/ [v9.0-*]: ${prefix}/${version}/reference/configuration/ -> ${base}/${version}/configuration/ [v9.0-*]: ${prefix}/${version}/reference/rails-integration/ -> ${base}/${version}/integrations-tools/rails-integration/ [v9.0-*]: ${prefix}/${version}/tutorials/ -> ${base}/${version}/ @@ -66,9 +68,9 @@ raw: ${prefix}/master -> ${base}/upcoming/ [v9.0-*]: ${prefix}/${version}/reference/callbacks/ -> ${base}/${version}/data-modeling/callbacks/ [v9.0-*]: ${prefix}/${version}/reference/sessions/ -> ${base}/${version}/interact-data/transaction/ [v9.0-*]: ${prefix}/${version}/reference/transactions/ -> ${base}/${version}/interact-data/transaction/ -[v9.0-*]: ${prefix}/${version}/release-notes/upgrading/ -> ${base}/${version}/whats-new/ -[v9.0-*]: ${prefix}/${version}/release-notes/mongoid-9.0/ -> ${base}/${version}/whats-new/ -[v9.0-master]: ${prefix}/${version}/release-notes/mongoid-8.0/ -> ${base}/${version}/whats-new/ +[v9.0-*]: ${prefix}/${version}/release-notes/upgrading/ -> ${base}/${version}/reference/release-notes/ +[v9.0-*]: ${prefix}/${version}/release-notes/mongoid-9.0/ -> ${base}/${version}/reference/release-notes/ +[v9.0-*]: ${prefix}/${version}/release-notes/mongoid-8.0/ -> ${base}/${version}/reference/release-notes/ [v9.0-*]: ${prefix}/${version}/contributing/code-documentation/ -> ${base}/${version}/code-documentation/ [v9.0-*]: ${prefix}/${version}/contributing/contributing-guidelines/ -> ${base}/${version}/issues-and-help/ [v9.0-*]: ${prefix}/${version}/additional-resources/ -> ${base}/${version}/integrations-tools/external-resources/ diff --git a/source/index.txt b/source/index.txt index 914bd0ea..b49cf7df 100644 --- a/source/index.txt +++ b/source/index.txt @@ -19,10 +19,8 @@ Secure Your Data Integrations & Tools API Documentation - Compatibility - What's New + Reference Issues & Help - View the Source Introduction ------------ @@ -92,11 +90,11 @@ To learn about the versions of the {+mdb-server+}, the {+language+} language, the {+ruby-driver+}, and {+ror+} framework that are compatible with each version of {+odm+}, see :ref:`mongoid-compatibility`. -What's New ----------- +Release Notes +------------- To view a list of new features and changes in each version, see the -:ref:`mongoid-whats-new` section. +:ref:`mongoid-release-notes` section. Issues & Help ------------- diff --git a/source/legacy-files/upgrading.txt b/source/legacy-files/upgrading.txt index ef6bdd3b..197f54a7 100644 --- a/source/legacy-files/upgrading.txt +++ b/source/legacy-files/upgrading.txt @@ -71,7 +71,7 @@ The following outlines our recommended procedure to upgrade to a new Mongoid ver If you haven't yet enabled the latest behavior on your current version, you should do so prior to upgrading. -3. Review the :ref:`Release Notes ` carefully when upgrading. +3. Review the :ref:`Release Notes ` carefully when upgrading. 4. Test your app on the new version. @@ -110,7 +110,7 @@ time to time. To do so, Mongoid may take one or more of the following actions: - Add a log warning if the deprecated functionality is used. -- Inform of the deprecation in the :ref:`Release Notes `. +- Inform of the deprecation in the :ref:`Release Notes `. Mongoid may then remove the deprecated functionality in the next major version release. diff --git a/source/reference.txt b/source/reference.txt new file mode 100644 index 00000000..b8f764d8 --- /dev/null +++ b/source/reference.txt @@ -0,0 +1,20 @@ +.. _mongoid-reference-landing: + +========= +Reference +========= + +.. meta:: + :description: Find reference materials about Mongoid compatibility and new features. + +.. toctree:: + :titlesonly: + :maxdepth: 1 + + Release Notes + Compatibility + View the Source + +- :ref:`Release Notes ` +- :ref:`Compatibility ` +- `{+odm+} Source Repository `__ diff --git a/source/compatibility.txt b/source/reference/compatibility.txt similarity index 100% rename from source/compatibility.txt rename to source/reference/compatibility.txt diff --git a/source/whats-new.txt b/source/reference/release-notes.txt similarity index 99% rename from source/whats-new.txt rename to source/reference/release-notes.txt index c98494ff..0a4a08fa 100644 --- a/source/whats-new.txt +++ b/source/reference/release-notes.txt @@ -1,13 +1,14 @@ .. _mongoid-whats-new: +.. _mongoid-release-notes: -========== -What's New -========== +============= +Release Notes +============= .. contents:: On this page :local: :backlinks: none - :depth: 1 + :depth: 2 :class: singlecol Learn what's new in: