RDoc-3176 Fix review comments

ravendb · Feb 24, 2025 · 88d7114 · 88d7114
1 parent d67f44e
commit 88d7114
Show file tree

Hide file tree

Showing 21 changed files with 66 additions and 35 deletions.
diff --git a/...mentation.Samples/DocumentExtensions/Revisions/ClientAPI/Operations/ConfigureRevisions.cs b/...mentation.Samples/DocumentExtensions/Revisions/ClientAPI/Operations/ConfigureRevisions.cs
@@ -30,7 +30,7 @@ public ConfigRevisions()
                     // ------------------------
                     // * A revision will be created anytime a document is modified or deleted.
                     // * Revisions of a deleted document can be accessed in the Revisions Bin view.
-                    // * At least 100 of the latest revisions will be kept.
+                    // * Only the latest 100 revisions will be kept. Older ones will be discarded.
                     // * Older revisions will be removed if they exceed 7 days on next revision creation.
                     // * A maximum of 15 revisions will be deleted each time a document is updated,
                     //   until the defined '# of revisions to keep' limit is reached.
@@ -174,7 +174,7 @@ public async Task ConfigRevisionsAsync()
                     // ------------------------
                     // * A revision will be created anytime a document is modified or deleted.
                     // * Revisions of a deleted document can be accessed in the Revisions Bin view.
-                    // * At least 100 of the latest revisions will be kept.
+                    // * Only the latest 100 revisions will be kept. Older ones will be discarded.
                     // * Older revisions will be removed if they exceed 7 days on next revision creation.
                     // * A maximum of 15 revisions will be deleted each time a document is updated,
                     //   until the defined '# of revisions to keep' limit is reached.

diff --git a/.../Samples/nodejs/document-extensions/revisions/client-api/operations/configureRevisions.js b/.../Samples/nodejs/document-extensions/revisions/client-api/operations/configureRevisions.js
@@ -19,7 +19,7 @@ async function configureRevisions() {
         // ------------------------
         // * A revision will be created anytime a document is modified or deleted.
         // * Revisions of a deleted document can be accessed in the Revisions Bin view.
-        // * At least 100 of the latest revisions will be kept.
+        // * Only the latest 100 revisions will be kept. Older ones will be discarded.
         // * Older revisions will be removed if they exceed 7 days on next revision creation.
         // * A maximum of 15 revisions will be deleted each time a document is updated,
         //   until the defined '# of revisions to keep' limit is reached.

diff --git a/...aven.Documentation.Pages/document-extensions/revisions/overview.dotnet.markdown b/...aven.Documentation.Pages/document-extensions/revisions/overview.dotnet.markdown
@@ -180,7 +180,12 @@ Let's play with revisions a little to get a taste of its advantages.
 5. **Delete the document**.  
    Though you deleted the document, its **audit trail** is **not lost**: all its revisions are moved to the [Revisions Bin](../../studio/database/document-extensions/revisions#revisions-bin),  
    including a new revision (called "Delete Revision"), created to indicate that the document was deleted.
-
+
+     {INFO: }
+     * A "Delete Revision" is created only if the deleted document has revisions.
+     * If a document has no revisions, a "Delete Revision" will be created only if the Revisions Configuration is set and enabled for its collection.
+     {INFO/}
+
      To see the revisions created for the document before it was deleted:
      * Open the `Documents > Revisions Bin` section in the Studio  
      * Click the deleted document's ID

diff --git a/....4/Raven.Documentation.Pages/document-extensions/revisions/overview.js.markdown b/....4/Raven.Documentation.Pages/document-extensions/revisions/overview.js.markdown
@@ -181,6 +181,11 @@ Let's play with revisions a little to get a taste of its advantages.
    Though you deleted the document, its **audit trail** is **not lost**: all its revisions are moved to the [Revisions Bin](../../studio/database/document-extensions/revisions#revisions-bin),  
    including a new revision (called "Delete Revision"), created to indicate that the document was deleted.
 
+     {INFO: }
+     * A "Delete Revision" is created only if the deleted document has revisions.
+     * If a document has no revisions, a "Delete Revision" will be created only if the Revisions Configuration is set and enabled for its collection.
+     {INFO/}
+
      To see the revisions created for the document before it was deleted:
      * Open the `Documents > Revisions Bin` section in the Studio
      * Click the deleted document's ID

diff --git a/...aven.Documentation.Pages/document-extensions/revisions/overview.python.markdown b/...aven.Documentation.Pages/document-extensions/revisions/overview.python.markdown
@@ -181,6 +181,11 @@ Let's play with revisions a little to get a taste of its advantages.
    Though you deleted the document, its **audit trail** is **not lost**: all its revisions are moved to the [Revisions Bin](../../studio/database/document-extensions/revisions#revisions-bin),  
    including a new revision (called "Delete Revision"), created to indicate that the document was deleted.
 
+     {INFO: }
+     * A "Delete Revision" is created only if the deleted document has revisions.
+     * If a document has no revisions, a "Delete Revision" will be created only if the Revisions Configuration is set and enabled for its collection.
+     {INFO/}
+
      To see the revisions created for the document before it was deleted:
      * Open the `Documents > Revisions Bin` section in the Studio
      * Click the deleted document's ID

diff --git a/...mentation.Samples/DocumentExtensions/Revisions/ClientAPI/Operations/ConfigureRevisions.cs b/...mentation.Samples/DocumentExtensions/Revisions/ClientAPI/Operations/ConfigureRevisions.cs
@@ -30,7 +30,7 @@ public ConfigRevisions()
                     // ------------------------
                     // * A revision will be created anytime a document is modified or deleted.
                     // * Revisions of a deleted document can be accessed in the Revisions Bin view.
-                    // * At least 100 of the latest revisions will be kept.
+                    // * Only the latest 100 revisions will be kept. Older ones will be discarded.
                     // * Older revisions will be removed if they exceed 7 days on next revision creation.
                     // * A maximum of 15 revisions will be deleted each time a document is updated,
                     //   until the defined '# of revisions to keep' limit is reached.
@@ -174,7 +174,7 @@ public async Task ConfigRevisionsAsync()
                     // ------------------------
                     // * A revision will be created anytime a document is modified or deleted.
                     // * Revisions of a deleted document can be accessed in the Revisions Bin view.
-                    // * At least 100 of the latest revisions will be kept.
+                    // * Only the latest 100 revisions will be kept. Older ones will be discarded.
                     // * Older revisions will be removed if they exceed 7 days on next revision creation.
                     // * A maximum of 15 revisions will be deleted each time a document is updated,
                     //   until the defined '# of revisions to keep' limit is reached.

diff --git a/...4/Samples/nodejs/documentExtensions/revisions/client-api/operations/configureRevisions.js b/...4/Samples/nodejs/documentExtensions/revisions/client-api/operations/configureRevisions.js
@@ -19,7 +19,7 @@ async function configureRevisions() {
         // ------------------------
         // * A revision will be created anytime a document is modified or deleted.
         // * Revisions of a deleted document can be accessed in the Revisions Bin view.
-        // * At least 100 of the latest revisions will be kept.
+        // * Only the latest 100 revisions will be kept. Older ones will be discarded.
         // * Older revisions will be removed if they exceed 7 days on next revision creation.
         // * A maximum of 15 revisions will be deleted each time a document is updated,
         //   until the defined '# of revisions to keep' limit is reached.

diff --git a/....4/Samples/python/DocumentExtensions/Revisions/ClientAPI/Operations/ConfigureRevisions.py b/....4/Samples/python/DocumentExtensions/Revisions/ClientAPI/Operations/ConfigureRevisions.py
@@ -29,7 +29,7 @@ def test_configure_revisions(self):
                     # ------------------------
                     # * A revision will be created anytime a document is modified or deleted.
                     # * Revisions of a deleted document can be accessed in the Revisions Bin view.
-                    # * At least 100 of the latest revisions will be kept.
+                    # * Only the latest 100 revisions will be kept. Older ones will be discarded.
                     # * Older revisions will be removed if they exceed 7 days on next revision creation.
                     # * A maximum of 15 revisions will be deleted each time a document is updated,
                     #   until the defined '# of revisions to keep' limit is reached.

diff --git a/...mentation.Samples/DocumentExtensions/Revisions/ClientAPI/Operations/ConfigureRevisions.cs b/...mentation.Samples/DocumentExtensions/Revisions/ClientAPI/Operations/ConfigureRevisions.cs
@@ -30,7 +30,7 @@ public ConfigRevisions()
                     // ------------------------
                     // * A revision will be created anytime a document is modified or deleted.
                     // * Revisions of a deleted document can be accessed in the Revisions Bin view.
-                    // * At least 100 of the latest revisions will be kept.
+                    // * Only the latest 100 revisions will be kept. Older ones will be discarded.
                     // * Older revisions will be removed if they exceed 7 days on next revision creation.
                     // * A maximum of 15 revisions will be deleted each time a document is updated,
                     //   until the defined '# of revisions to keep' limit is reached.
@@ -174,7 +174,7 @@ public async Task ConfigRevisionsAsync()
                     // ------------------------
                     // * A revision will be created anytime a document is modified or deleted.
                     // * Revisions of a deleted document can be accessed in the Revisions Bin view.
-                    // * At least 100 of the latest revisions will be kept.
+                    // * Only the latest 100 revisions will be kept. Older ones will be discarded.
                     // * Older revisions will be removed if they exceed 7 days on next revision creation.
                     // * A maximum of 15 revisions will be deleted each time a document is updated,
                     //   until the defined '# of revisions to keep' limit is reached.

diff --git a/.../Samples/nodejs/document-extensions/revisions/client-api/operations/configureRevisions.js b/.../Samples/nodejs/document-extensions/revisions/client-api/operations/configureRevisions.js
@@ -19,7 +19,7 @@ async function configureRevisions() {
         // ------------------------
         // * A revision will be created anytime a document is modified or deleted.
         // * Revisions of a deleted document can be accessed in the Revisions Bin view.
-        // * At least 100 of the latest revisions will be kept.
+        // * Only the latest 100 revisions will be kept. Older ones will be discarded.
         // * Older revisions will be removed if they exceed 7 days on next revision creation.
         // * A maximum of 15 revisions will be deleted each time a document is updated,
         //   until the defined '# of revisions to keep' limit is reached.

diff --git a/....0/Samples/python/DocumentExtensions/Revisions/ClientAPI/Operations/ConfigureRevisions.py b/....0/Samples/python/DocumentExtensions/Revisions/ClientAPI/Operations/ConfigureRevisions.py
@@ -29,7 +29,7 @@ def test_configure_revisions(self):
                     # ------------------------
                     # * A revision will be created anytime a document is modified or deleted.
                     # * Revisions of a deleted document can be accessed in the Revisions Bin view.
-                    # * At least 100 of the latest revisions will be kept.
+                    # * Only the latest 100 revisions will be kept. Older ones will be discarded.
                     # * Older revisions will be removed if they exceed 7 days on next revision creation.
                     # * A maximum of 15 revisions will be deleted each time a document is updated,
                     #   until the defined '# of revisions to keep' limit is reached.

diff --git a/...ent-extensions/revisions/client-api/operations/delete-revisions.dotnet.markdown b/...ent-extensions/revisions/client-api/operations/delete-revisions.dotnet.markdown
@@ -88,7 +88,7 @@ Consider the following scenario:
 
 4. If you remove this "Delete Revision" by providing its change vector to `DeleteRevisionsOperation`,  
    the "Delete Revision" will be removed from the Revisions Bin, causing the associated revisions to become orphaned.  
-   As a result, you will no longer have access to these revisions.
+   As a result, you will no longer have access to these revisions via the Revisions Bin.
 
 {CONTENT-FRAME/}
 {PANEL/}

diff --git a/...ocumentation.Pages/document-extensions/revisions/revisions-bin-cleaner.markdown b/...ocumentation.Pages/document-extensions/revisions/revisions-bin-cleaner.markdown
@@ -34,9 +34,6 @@ ALL the revisions associated with the deleted document are **permanently deleted
     * **Frequency** - How often the cleaner runs.
     * **Entries age to keep** - The cleaner deletes revision entries older than this value.
 
-* The delete action runs in batches. The batch size (hard-coded) depends on whether the machine is 32-bit or higher.
-  Older entries are deleted first.
-
 * The cleaner task can be managed from:  
   * The [Revisions bin cleaner view](../../document-extensions/revisions/revisions-bin-cleaner#setting-the-revisions-bin-cleaner---from-the-studio) in the Studio
   * The [Client API](../../document-extensions/revisions/revisions-bin-cleaner#setting-the-revisions-bin-cleaner---from-the-client-api).

diff --git a/...aven.Documentation.Pages/document-extensions/revisions/overview.dotnet.markdown b/...aven.Documentation.Pages/document-extensions/revisions/overview.dotnet.markdown
@@ -181,6 +181,11 @@ Let's play with revisions a little to get a taste of its advantages.
    Though you deleted the document, its **audit trail** is **not lost**: all its revisions are moved to the [Revisions Bin](../../studio/database/document-extensions/revisions/revisions-bin),  
    including a new revision (called "Delete Revision"), created to indicate that the document was deleted.
 
+     {INFO: } 
+     * A "Delete Revision" is created only if the deleted document has revisions.
+     * If a document has no revisions, a "Delete Revision" will be created only if the Revisions Configuration is set and enabled for its collection.
+     {INFO/}
+
      To see the revisions created for the document before it was deleted:  
      * Open the `Documents > Revisions Bin` section in the Studio  
      * Click the deleted document's ID  

diff --git a/....0/Raven.Documentation.Pages/document-extensions/revisions/overview.js.markdown b/....0/Raven.Documentation.Pages/document-extensions/revisions/overview.js.markdown
@@ -181,6 +181,11 @@ Let's play with revisions a little to get a taste of its advantages.
    Though you deleted the document, its **audit trail** is **not lost**: all its revisions were moved to the [Revisions Bin](../../studio/database/document-extensions/revisions/revisions-bin),  
    including a new revision (called "Delete Revision"), created to indicate that the document was deleted.
 
+     {INFO: }
+     * A "Delete Revision" is created only if the deleted document has revisions.
+     * If a document has no revisions, a "Delete Revision" will be created only if the Revisions Configuration is set and enabled for its collection.
+     {INFO/}
+
      To see the revisions created for the document before it was deleted:  
      * Open the `Documents > Revisions Bin` section in the Studio  
      * Click the deleted document's ID

diff --git a/...aven.Documentation.Pages/document-extensions/revisions/overview.python.markdown b/...aven.Documentation.Pages/document-extensions/revisions/overview.python.markdown
@@ -181,11 +181,16 @@ Let's play with revisions a little to get a taste of its advantages.
    Though you deleted the document, its **audit trail** is **not lost**: all its revisions were moved to the [Revisions Bin](../../studio/database/document-extensions/revisions/revisions-bin),  
    including a new revision (called "Delete Revision"), created to indicate that the document was deleted.
 
-      To see the revisions created for the document before it was deleted:  
-      * Open the `Documents > Revisions Bin` section in the Studio  
-      * Click the deleted document's ID  
+     {INFO: }
+     * A "Delete Revision" is created only if the deleted document has revisions.
+     * If a document has no revisions, a "Delete Revision" will be created only if the Revisions Configuration is set and enabled for its collection.
+     {INFO/}
 
-      ![Revisions Bin](images\revisions-5.png "Revisions Bin")
+     To see the revisions created for the document before it was deleted:  
+     * Open the `Documents > Revisions Bin` section in the Studio  
+     * Click the deleted document's ID  
+
+     ![Revisions Bin](images\revisions-5.png "Revisions Bin")
 
 6. **Restore the document**.  
    Even after a document is deleted, you can still restore it from one of its revisions.  

diff --git a/...ocumentation.Pages/document-extensions/revisions/revisions-bin-cleaner.markdown b/...ocumentation.Pages/document-extensions/revisions/revisions-bin-cleaner.markdown
@@ -36,9 +36,6 @@ ALL the revisions associated with the deleted document are **permanently deleted
     * **Frequency** - How often the cleaner runs.
     * **Entries age to keep** - The cleaner deletes revision entries older than this value.
 
-* The delete action runs in batches. The batch size (hard-coded) depends on whether the machine is 32-bit or higher.
-  Older entries are deleted first.
-
 * The cleaner task can be managed from:  
   * The [Revisions bin cleaner view](../../document-extensions/revisions/revisions-bin-cleaner#setting-the-revisions-bin-cleaner---from-the-studio) in the Studio
   * The [Client API](../../document-extensions/revisions/revisions-bin-cleaner#setting-the-revisions-bin-cleaner---from-the-client-api).

diff --git a/...tion.Pages/studio/database/document-extensions/revisions/revisions-bin.markdown b/...tion.Pages/studio/database/document-extensions/revisions/revisions-bin.markdown
@@ -21,9 +21,14 @@
 
 * In RavenDB, revisions can be created automatically or manually, as explained in this [overview](../../../../document-extensions/revisions/overview).
 
-* Regardless of how revisions are created or whether [revisions configuration](../../../../studio/database/settings/document-revisions#revisions-configuration) is enabled,
-  deleting a document that **has** revisions will always create a `"Delete Revision"`.
-  If you delete a document that does Not have revisions, a "Delete Revision" will be created only if the revisions configuration is set and enabled.
+* **When deleting a document that has revisions**:  
+  Deleting a document that has revisions will always create a `"Delete Revision"`.  
+  This occurs regardless of whether the revisions were created automatically or manually,  
+  or if the [Revisions configuration](../../../../studio/database/settings/document-revisions#revisions-configuration) is enabled.
+
+* **When deleting a document that does Not have revisions**:  
+  If you delete a document that does not have revisions, a "Delete Revision" will be created only if the revisions configuration is set and enabled.
+  In that case, another revision will be created to capture the document’s state at the time of deletion.
 
 * This "Delete Revision" marks the document's deletion and is stored in the **Revisions Bin**.  
   In addition, all the revisions that were created over time for the deleted document are also moved to the Revisions Bin.
@@ -81,10 +86,10 @@ Clicking the `orders/829-A` ID from the above list will open the following view:
 
 1. This is the ID of the deleted document.
 2. The "DELETE REVISION" label indicates that you are viewing a "Delete Revision".
-3. This text appears for a "Delete Revision," displaying the time when the document was removed.  
+3. This text appears for a "Delete Revision," displaying the time when the document was removed.
    The flags include the `DeleteRevision` flag, confirming it is a "Delete Revision."
-4. The timestamp of the "Delete Revision". 
-5. These are the revisions that were created for the document before it was deleted.  
+4. The timestamp of the "Delete Revision", indicating when the document was deleted.
+5. These are the revisions that were created for the document before it was deleted.
    You can click on each one to view and manage it like any other revision,  
    e.g., clone it or compare it with other revisions. 
 
@@ -96,7 +101,8 @@ Clicking the `orders/829-A` ID from the above list will open the following view:
   To restore them, create a new document with the **exact same ID** as the deleted document.  
 
 * When a new document is created with the same ID:  
-  * The revisions of the deleted document are retrieved from the Revisions Bin and associated with the new document.
+  * The revisions of the deleted document are retrieved from the Revisions Bin and associated with the new document.  
+    This occurs even if the [Revisions configuration](../../../../studio/database/settings/document-revisions#revisions-configuration) is not defined or enabled for this document collection at the time.
   * These revisions are removed from the Revisions Bin once restored.
   * The "Delete Revision" that marked the original document's deletion will also be removed from the Revisions Bin  
     and will now appear in the new document’s revision history.
@@ -105,7 +111,8 @@ Clicking the `orders/829-A` ID from the above list will open the following view:
 
 1. The ID of the deleted document that was recreated.
 2. The content of the newly created document.
-3. This is the latest revision, indicating the creation of the new document.
+3. If the [Revisions configuration](../../../../studio/database/settings/document-revisions#revisions-configuration)
+   is defined and enabled for the document collection at the time of creating the new document, a new revision marking its creation will be generated.
 4. This is the "Delete Revision" that marked the deletion of the original document.   
    This revision is now part of the new document's revision history.
 6. These are the revisions of the deleted document that are now restored.