diff --git a/documentation/sphinx/source/api-python.rst b/documentation/sphinx/source/api-python.rst index d332e3c2a2..650a96fa93 100644 --- a/documentation/sphinx/source/api-python.rst +++ b/documentation/sphinx/source/api-python.rst @@ -98,7 +98,7 @@ When you import the ``fdb`` module, it exposes only one useful symbol: .. warning:: |api-version-multi-version-warning| -For API changes between version 13 and |api-version| (for the purpose of porting older programs), see :doc:`release-notes` and :doc:`api-version-upgrade-guide`. +For API changes between version 13 and |api-version| (for the purpose of porting older programs), see :ref:`release-notes` and :doc:`api-version-upgrade-guide`. Opening a database ================== diff --git a/documentation/sphinx/source/api-ruby.rst b/documentation/sphinx/source/api-ruby.rst index cd980e4088..f57319218b 100644 --- a/documentation/sphinx/source/api-ruby.rst +++ b/documentation/sphinx/source/api-ruby.rst @@ -87,7 +87,7 @@ When you require the ``FDB`` gem, it exposes only one useful method: .. warning:: |api-version-multi-version-warning| -For API changes between version 14 and |api-version| (for the purpose of porting older programs), see :doc:`release-notes` and :doc:`api-version-upgrade-guide`. +For API changes between version 14 and |api-version| (for the purpose of porting older programs), see :ref:`release-notes` and :doc:`api-version-upgrade-guide`. Opening a database ================== diff --git a/documentation/sphinx/source/api-version-upgrade-guide.rst b/documentation/sphinx/source/api-version-upgrade-guide.rst index eab7f8b6a2..e443a78a4b 100644 --- a/documentation/sphinx/source/api-version-upgrade-guide.rst +++ b/documentation/sphinx/source/api-version-upgrade-guide.rst @@ -213,4 +213,4 @@ Java bindings Older API versions ================== -API versions from the beta and alpha releases of Foundationdb (pre-100) are not documented here. See :doc:`old-release-notes/release-notes-023` for details about changes in those releases. +API versions from the beta and alpha releases of Foundationdb (pre-100) are not documented here. See :doc:`release-notes/release-notes-023` for details about changes in those releases. diff --git a/documentation/sphinx/source/client-design.rst b/documentation/sphinx/source/client-design.rst index c9706f0f46..640736a688 100644 --- a/documentation/sphinx/source/client-design.rst +++ b/documentation/sphinx/source/client-design.rst @@ -2,7 +2,7 @@ Client Design ############# -FoundationDB supports language bindings for application development using the ordered key-value store. The following documents cover use of the bindings, from getting started and design principles to best practices and data modeling. The latest changes are detailed in :doc:`release-notes`. +FoundationDB supports language bindings for application development using the ordered key-value store. The following documents cover use of the bindings, from getting started and design principles to best practices and data modeling. The latest changes are detailed in :ref:`release-notes`. * :doc:`getting-started-mac` explains how to install a local FoundationDB server suitable for development on macOS. @@ -27,7 +27,6 @@ FoundationDB supports language bindings for application development using the or :titlesonly: :hidden: - release-notes getting-started-mac getting-started-linux downloads diff --git a/documentation/sphinx/source/earlier-release-notes.rst b/documentation/sphinx/source/earlier-release-notes.rst index 4ccbe1f59f..245cd17d31 100644 --- a/documentation/sphinx/source/earlier-release-notes.rst +++ b/documentation/sphinx/source/earlier-release-notes.rst @@ -12,4 +12,4 @@ were used to track the feature's development. :maxdepth: 1 :glob: - old-release-notes/* + release-notes/* diff --git a/documentation/sphinx/source/index.rst b/documentation/sphinx/source/index.rst index d86bb09757..737731d36e 100644 --- a/documentation/sphinx/source/index.rst +++ b/documentation/sphinx/source/index.rst @@ -22,7 +22,7 @@ FoundationDB is a robust choice for a broad range of use cases: **FoundationDB supports flexible application architectures.** Your application can talk directly to FoundationDB, to a layer, or both. Layers provide new capability on top of FoundationDB but are stateless. -The latest changes are detailed in :doc:`release-notes`. The documentation has the following sections: +The latest changes are detailed in :ref:`release-notes`. The documentation has the following sections: * :doc:`why-foundationdb` describes the technical alternatives involved in NoSQL database design and explains the advantages of transaction processing at scale. diff --git a/documentation/sphinx/source/old-release-notes/release-notes-014.rst b/documentation/sphinx/source/release-notes/release-notes-014.rst similarity index 100% rename from documentation/sphinx/source/old-release-notes/release-notes-014.rst rename to documentation/sphinx/source/release-notes/release-notes-014.rst diff --git a/documentation/sphinx/source/old-release-notes/release-notes-016.rst b/documentation/sphinx/source/release-notes/release-notes-016.rst similarity index 100% rename from documentation/sphinx/source/old-release-notes/release-notes-016.rst rename to documentation/sphinx/source/release-notes/release-notes-016.rst diff --git a/documentation/sphinx/source/old-release-notes/release-notes-021.rst b/documentation/sphinx/source/release-notes/release-notes-021.rst similarity index 100% rename from documentation/sphinx/source/old-release-notes/release-notes-021.rst rename to documentation/sphinx/source/release-notes/release-notes-021.rst diff --git a/documentation/sphinx/source/old-release-notes/release-notes-022.rst b/documentation/sphinx/source/release-notes/release-notes-022.rst similarity index 100% rename from documentation/sphinx/source/old-release-notes/release-notes-022.rst rename to documentation/sphinx/source/release-notes/release-notes-022.rst diff --git a/documentation/sphinx/source/old-release-notes/release-notes-023.rst b/documentation/sphinx/source/release-notes/release-notes-023.rst similarity index 100% rename from documentation/sphinx/source/old-release-notes/release-notes-023.rst rename to documentation/sphinx/source/release-notes/release-notes-023.rst diff --git a/documentation/sphinx/source/old-release-notes/release-notes-100.rst b/documentation/sphinx/source/release-notes/release-notes-100.rst similarity index 100% rename from documentation/sphinx/source/old-release-notes/release-notes-100.rst rename to documentation/sphinx/source/release-notes/release-notes-100.rst diff --git a/documentation/sphinx/source/old-release-notes/release-notes-200.rst b/documentation/sphinx/source/release-notes/release-notes-200.rst similarity index 100% rename from documentation/sphinx/source/old-release-notes/release-notes-200.rst rename to documentation/sphinx/source/release-notes/release-notes-200.rst diff --git a/documentation/sphinx/source/old-release-notes/release-notes-300.rst b/documentation/sphinx/source/release-notes/release-notes-300.rst similarity index 100% rename from documentation/sphinx/source/old-release-notes/release-notes-300.rst rename to documentation/sphinx/source/release-notes/release-notes-300.rst diff --git a/documentation/sphinx/source/old-release-notes/release-notes-400.rst b/documentation/sphinx/source/release-notes/release-notes-400.rst similarity index 100% rename from documentation/sphinx/source/old-release-notes/release-notes-400.rst rename to documentation/sphinx/source/release-notes/release-notes-400.rst diff --git a/documentation/sphinx/source/old-release-notes/release-notes-410.rst b/documentation/sphinx/source/release-notes/release-notes-410.rst similarity index 100% rename from documentation/sphinx/source/old-release-notes/release-notes-410.rst rename to documentation/sphinx/source/release-notes/release-notes-410.rst diff --git a/documentation/sphinx/source/old-release-notes/release-notes-420.rst b/documentation/sphinx/source/release-notes/release-notes-420.rst similarity index 100% rename from documentation/sphinx/source/old-release-notes/release-notes-420.rst rename to documentation/sphinx/source/release-notes/release-notes-420.rst diff --git a/documentation/sphinx/source/old-release-notes/release-notes-430.rst b/documentation/sphinx/source/release-notes/release-notes-430.rst similarity index 100% rename from documentation/sphinx/source/old-release-notes/release-notes-430.rst rename to documentation/sphinx/source/release-notes/release-notes-430.rst diff --git a/documentation/sphinx/source/old-release-notes/release-notes-440.rst b/documentation/sphinx/source/release-notes/release-notes-440.rst similarity index 100% rename from documentation/sphinx/source/old-release-notes/release-notes-440.rst rename to documentation/sphinx/source/release-notes/release-notes-440.rst diff --git a/documentation/sphinx/source/old-release-notes/release-notes-450.rst b/documentation/sphinx/source/release-notes/release-notes-450.rst similarity index 100% rename from documentation/sphinx/source/old-release-notes/release-notes-450.rst rename to documentation/sphinx/source/release-notes/release-notes-450.rst diff --git a/documentation/sphinx/source/old-release-notes/release-notes-460.rst b/documentation/sphinx/source/release-notes/release-notes-460.rst similarity index 84% rename from documentation/sphinx/source/old-release-notes/release-notes-460.rst rename to documentation/sphinx/source/release-notes/release-notes-460.rst index 217ac141c9..c581a0731c 100644 --- a/documentation/sphinx/source/old-release-notes/release-notes-460.rst +++ b/documentation/sphinx/source/release-notes/release-notes-460.rst @@ -119,17 +119,17 @@ Status Earlier release notes --------------------- -* :doc:`4.5 (API Version 450) ` -* :doc:`4.4 (API Version 440) ` -* :doc:`4.3 (API Version 430) ` -* :doc:`4.2 (API Version 420) ` -* :doc:`4.1 (API Version 410) ` -* :doc:`4.0 (API Version 400) ` -* :doc:`3.0 (API Version 300) ` -* :doc:`2.0 (API Version 200) ` -* :doc:`1.0 (API Version 100) ` -* :doc:`Beta 3 (API Version 23) ` -* :doc:`Beta 2 (API Version 22) ` -* :doc:`Beta 1 (API Version 21) ` -* :doc:`Alpha 6 (API Version 16) ` -* :doc:`Alpha 5 (API Version 14) ` +* :doc:`4.5 (API Version 450) ` +* :doc:`4.4 (API Version 440) ` +* :doc:`4.3 (API Version 430) ` +* :doc:`4.2 (API Version 420) ` +* :doc:`4.1 (API Version 410) ` +* :doc:`4.0 (API Version 400) ` +* :doc:`3.0 (API Version 300) ` +* :doc:`2.0 (API Version 200) ` +* :doc:`1.0 (API Version 100) ` +* :doc:`Beta 3 (API Version 23) ` +* :doc:`Beta 2 (API Version 22) ` +* :doc:`Beta 1 (API Version 21) ` +* :doc:`Alpha 6 (API Version 16) ` +* :doc:`Alpha 5 (API Version 14) ` diff --git a/documentation/sphinx/source/old-release-notes/release-notes-500.rst b/documentation/sphinx/source/release-notes/release-notes-500.rst similarity index 89% rename from documentation/sphinx/source/old-release-notes/release-notes-500.rst rename to documentation/sphinx/source/release-notes/release-notes-500.rst index 600a8ff727..13b6b8ead1 100644 --- a/documentation/sphinx/source/old-release-notes/release-notes-500.rst +++ b/documentation/sphinx/source/release-notes/release-notes-500.rst @@ -173,18 +173,18 @@ Other Changes Earlier release notes --------------------- -* :doc:`4.6 (API Version 460) ` -* :doc:`4.5 (API Version 450) ` -* :doc:`4.4 (API Version 440) ` -* :doc:`4.3 (API Version 430) ` -* :doc:`4.2 (API Version 420) ` -* :doc:`4.1 (API Version 410) ` -* :doc:`4.0 (API Version 400) ` -* :doc:`3.0 (API Version 300) ` -* :doc:`2.0 (API Version 200) ` -* :doc:`1.0 (API Version 100) ` -* :doc:`Beta 3 (API Version 23) ` -* :doc:`Beta 2 (API Version 22) ` -* :doc:`Beta 1 (API Version 21) ` -* :doc:`Alpha 6 (API Version 16) ` -* :doc:`Alpha 5 (API Version 14) ` +* :doc:`4.6 (API Version 460) ` +* :doc:`4.5 (API Version 450) ` +* :doc:`4.4 (API Version 440) ` +* :doc:`4.3 (API Version 430) ` +* :doc:`4.2 (API Version 420) ` +* :doc:`4.1 (API Version 410) ` +* :doc:`4.0 (API Version 400) ` +* :doc:`3.0 (API Version 300) ` +* :doc:`2.0 (API Version 200) ` +* :doc:`1.0 (API Version 100) ` +* :doc:`Beta 3 (API Version 23) ` +* :doc:`Beta 2 (API Version 22) ` +* :doc:`Beta 1 (API Version 21) ` +* :doc:`Alpha 6 (API Version 16) ` +* :doc:`Alpha 5 (API Version 14) ` diff --git a/documentation/sphinx/source/old-release-notes/release-notes-510.rst b/documentation/sphinx/source/release-notes/release-notes-510.rst similarity index 91% rename from documentation/sphinx/source/old-release-notes/release-notes-510.rst rename to documentation/sphinx/source/release-notes/release-notes-510.rst index beff87cc3a..8e3fc54063 100644 --- a/documentation/sphinx/source/old-release-notes/release-notes-510.rst +++ b/documentation/sphinx/source/release-notes/release-notes-510.rst @@ -196,19 +196,19 @@ Other Changes Earlier release notes --------------------- -* :doc:`5.0 (API Version 500) ` -* :doc:`4.6 (API Version 460) ` -* :doc:`4.5 (API Version 450) ` -* :doc:`4.4 (API Version 440) ` -* :doc:`4.3 (API Version 430) ` -* :doc:`4.2 (API Version 420) ` -* :doc:`4.1 (API Version 410) ` -* :doc:`4.0 (API Version 400) ` -* :doc:`3.0 (API Version 300) ` -* :doc:`2.0 (API Version 200) ` -* :doc:`1.0 (API Version 100) ` -* :doc:`Beta 3 (API Version 23) ` -* :doc:`Beta 2 (API Version 22) ` -* :doc:`Beta 1 (API Version 21) ` -* :doc:`Alpha 6 (API Version 16) ` -* :doc:`Alpha 5 (API Version 14) ` +* :doc:`5.0 (API Version 500) ` +* :doc:`4.6 (API Version 460) ` +* :doc:`4.5 (API Version 450) ` +* :doc:`4.4 (API Version 440) ` +* :doc:`4.3 (API Version 430) ` +* :doc:`4.2 (API Version 420) ` +* :doc:`4.1 (API Version 410) ` +* :doc:`4.0 (API Version 400) ` +* :doc:`3.0 (API Version 300) ` +* :doc:`2.0 (API Version 200) ` +* :doc:`1.0 (API Version 100) ` +* :doc:`Beta 3 (API Version 23) ` +* :doc:`Beta 2 (API Version 22) ` +* :doc:`Beta 1 (API Version 21) ` +* :doc:`Alpha 6 (API Version 16) ` +* :doc:`Alpha 5 (API Version 14) ` diff --git a/documentation/sphinx/source/old-release-notes/release-notes-520.rst b/documentation/sphinx/source/release-notes/release-notes-520.rst similarity index 83% rename from documentation/sphinx/source/old-release-notes/release-notes-520.rst rename to documentation/sphinx/source/release-notes/release-notes-520.rst index 3ea8818aee..dadb1e04f2 100644 --- a/documentation/sphinx/source/old-release-notes/release-notes-520.rst +++ b/documentation/sphinx/source/release-notes/release-notes-520.rst @@ -99,20 +99,20 @@ Other Changes Earlier release notes --------------------- -* :doc:`5.1 (API Version 510) ` -* :doc:`5.0 (API Version 500) ` -* :doc:`4.6 (API Version 460) ` -* :doc:`4.5 (API Version 450) ` -* :doc:`4.4 (API Version 440) ` -* :doc:`4.3 (API Version 430) ` -* :doc:`4.2 (API Version 420) ` -* :doc:`4.1 (API Version 410) ` -* :doc:`4.0 (API Version 400) ` -* :doc:`3.0 (API Version 300) ` -* :doc:`2.0 (API Version 200) ` -* :doc:`1.0 (API Version 100) ` -* :doc:`Beta 3 (API Version 23) ` -* :doc:`Beta 2 (API Version 22) ` -* :doc:`Beta 1 (API Version 21) ` -* :doc:`Alpha 6 (API Version 16) ` -* :doc:`Alpha 5 (API Version 14) ` +* :doc:`5.1 (API Version 510) ` +* :doc:`5.0 (API Version 500) ` +* :doc:`4.6 (API Version 460) ` +* :doc:`4.5 (API Version 450) ` +* :doc:`4.4 (API Version 440) ` +* :doc:`4.3 (API Version 430) ` +* :doc:`4.2 (API Version 420) ` +* :doc:`4.1 (API Version 410) ` +* :doc:`4.0 (API Version 400) ` +* :doc:`3.0 (API Version 300) ` +* :doc:`2.0 (API Version 200) ` +* :doc:`1.0 (API Version 100) ` +* :doc:`Beta 3 (API Version 23) ` +* :doc:`Beta 2 (API Version 22) ` +* :doc:`Beta 1 (API Version 21) ` +* :doc:`Alpha 6 (API Version 16) ` +* :doc:`Alpha 5 (API Version 14) ` diff --git a/documentation/sphinx/source/old-release-notes/release-notes-600.rst b/documentation/sphinx/source/release-notes/release-notes-600.rst similarity index 92% rename from documentation/sphinx/source/old-release-notes/release-notes-600.rst rename to documentation/sphinx/source/release-notes/release-notes-600.rst index a934dcae29..f3a921b15b 100644 --- a/documentation/sphinx/source/old-release-notes/release-notes-600.rst +++ b/documentation/sphinx/source/release-notes/release-notes-600.rst @@ -161,21 +161,21 @@ Other Changes Earlier release notes --------------------- -* :doc:`5.2 (API Version 520) ` -* :doc:`5.1 (API Version 510) ` -* :doc:`5.0 (API Version 500) ` -* :doc:`4.6 (API Version 460) ` -* :doc:`4.5 (API Version 450) ` -* :doc:`4.4 (API Version 440) ` -* :doc:`4.3 (API Version 430) ` -* :doc:`4.2 (API Version 420) ` -* :doc:`4.1 (API Version 410) ` -* :doc:`4.0 (API Version 400) ` -* :doc:`3.0 (API Version 300) ` -* :doc:`2.0 (API Version 200) ` -* :doc:`1.0 (API Version 100) ` -* :doc:`Beta 3 (API Version 23) ` -* :doc:`Beta 2 (API Version 22) ` -* :doc:`Beta 1 (API Version 21) ` -* :doc:`Alpha 6 (API Version 16) ` -* :doc:`Alpha 5 (API Version 14) ` +* :doc:`5.2 (API Version 520) ` +* :doc:`5.1 (API Version 510) ` +* :doc:`5.0 (API Version 500) ` +* :doc:`4.6 (API Version 460) ` +* :doc:`4.5 (API Version 450) ` +* :doc:`4.4 (API Version 440) ` +* :doc:`4.3 (API Version 430) ` +* :doc:`4.2 (API Version 420) ` +* :doc:`4.1 (API Version 410) ` +* :doc:`4.0 (API Version 400) ` +* :doc:`3.0 (API Version 300) ` +* :doc:`2.0 (API Version 200) ` +* :doc:`1.0 (API Version 100) ` +* :doc:`Beta 3 (API Version 23) ` +* :doc:`Beta 2 (API Version 22) ` +* :doc:`Beta 1 (API Version 21) ` +* :doc:`Alpha 6 (API Version 16) ` +* :doc:`Alpha 5 (API Version 14) ` diff --git a/documentation/sphinx/source/old-release-notes/release-notes-610.rst b/documentation/sphinx/source/release-notes/release-notes-610.rst similarity index 94% rename from documentation/sphinx/source/old-release-notes/release-notes-610.rst rename to documentation/sphinx/source/release-notes/release-notes-610.rst index 6727195240..75c37aad59 100644 --- a/documentation/sphinx/source/old-release-notes/release-notes-610.rst +++ b/documentation/sphinx/source/release-notes/release-notes-610.rst @@ -180,22 +180,22 @@ Fixes only impacting 6.1.0+ Earlier release notes --------------------- -* :doc:`6.0 (API Version 600) ` -* :doc:`5.2 (API Version 520) ` -* :doc:`5.1 (API Version 510) ` -* :doc:`5.0 (API Version 500) ` -* :doc:`4.6 (API Version 460) ` -* :doc:`4.5 (API Version 450) ` -* :doc:`4.4 (API Version 440) ` -* :doc:`4.3 (API Version 430) ` -* :doc:`4.2 (API Version 420) ` -* :doc:`4.1 (API Version 410) ` -* :doc:`4.0 (API Version 400) ` -* :doc:`3.0 (API Version 300) ` -* :doc:`2.0 (API Version 200) ` -* :doc:`1.0 (API Version 100) ` -* :doc:`Beta 3 (API Version 23) ` -* :doc:`Beta 2 (API Version 22) ` -* :doc:`Beta 1 (API Version 21) ` -* :doc:`Alpha 6 (API Version 16) ` -* :doc:`Alpha 5 (API Version 14) ` +* :doc:`6.0 (API Version 600) ` +* :doc:`5.2 (API Version 520) ` +* :doc:`5.1 (API Version 510) ` +* :doc:`5.0 (API Version 500) ` +* :doc:`4.6 (API Version 460) ` +* :doc:`4.5 (API Version 450) ` +* :doc:`4.4 (API Version 440) ` +* :doc:`4.3 (API Version 430) ` +* :doc:`4.2 (API Version 420) ` +* :doc:`4.1 (API Version 410) ` +* :doc:`4.0 (API Version 400) ` +* :doc:`3.0 (API Version 300) ` +* :doc:`2.0 (API Version 200) ` +* :doc:`1.0 (API Version 100) ` +* :doc:`Beta 3 (API Version 23) ` +* :doc:`Beta 2 (API Version 22) ` +* :doc:`Beta 1 (API Version 21) ` +* :doc:`Alpha 6 (API Version 16) ` +* :doc:`Alpha 5 (API Version 14) ` diff --git a/documentation/sphinx/source/release-notes.rst b/documentation/sphinx/source/release-notes/release-notes-620.rst similarity index 95% rename from documentation/sphinx/source/release-notes.rst rename to documentation/sphinx/source/release-notes/release-notes-620.rst index b05fdfbe6c..51392f07d5 100644 --- a/documentation/sphinx/source/release-notes.rst +++ b/documentation/sphinx/source/release-notes/release-notes-620.rst @@ -1,3 +1,5 @@ +.. _release-notes: + ############# Release Notes ############# @@ -356,23 +358,23 @@ Fixes only impacting 6.2.0+ Earlier release notes --------------------- -* :doc:`6.1 (API Version 610) ` -* :doc:`6.0 (API Version 600) ` -* :doc:`5.2 (API Version 520) ` -* :doc:`5.1 (API Version 510) ` -* :doc:`5.0 (API Version 500) ` -* :doc:`4.6 (API Version 460) ` -* :doc:`4.5 (API Version 450) ` -* :doc:`4.4 (API Version 440) ` -* :doc:`4.3 (API Version 430) ` -* :doc:`4.2 (API Version 420) ` -* :doc:`4.1 (API Version 410) ` -* :doc:`4.0 (API Version 400) ` -* :doc:`3.0 (API Version 300) ` -* :doc:`2.0 (API Version 200) ` -* :doc:`1.0 (API Version 100) ` -* :doc:`Beta 3 (API Version 23) ` -* :doc:`Beta 2 (API Version 22) ` -* :doc:`Beta 1 (API Version 21) ` -* :doc:`Alpha 6 (API Version 16) ` -* :doc:`Alpha 5 (API Version 14) ` +* :doc:`6.1 (API Version 610) ` +* :doc:`6.0 (API Version 600) ` +* :doc:`5.2 (API Version 520) ` +* :doc:`5.1 (API Version 510) ` +* :doc:`5.0 (API Version 500) ` +* :doc:`4.6 (API Version 460) ` +* :doc:`4.5 (API Version 450) ` +* :doc:`4.4 (API Version 440) ` +* :doc:`4.3 (API Version 430) ` +* :doc:`4.2 (API Version 420) ` +* :doc:`4.1 (API Version 410) ` +* :doc:`4.0 (API Version 400) ` +* :doc:`3.0 (API Version 300) ` +* :doc:`2.0 (API Version 200) ` +* :doc:`1.0 (API Version 100) ` +* :doc:`Beta 3 (API Version 23) ` +* :doc:`Beta 2 (API Version 22) ` +* :doc:`Beta 1 (API Version 21) ` +* :doc:`Alpha 6 (API Version 16) ` +* :doc:`Alpha 5 (API Version 14) `