diff --git a/Documentation/5.3/Raven.Documentation.Pages/studio/database/document-extensions/.docs.json b/Documentation/5.3/Raven.Documentation.Pages/studio/database/document-extensions/.docs.json index 778f70b459..d29b3c9086 100644 --- a/Documentation/5.3/Raven.Documentation.Pages/studio/database/document-extensions/.docs.json +++ b/Documentation/5.3/Raven.Documentation.Pages/studio/database/document-extensions/.docs.json @@ -15,6 +15,12 @@ "Path": "revisions.markdown", "Name": "Revisions", "DiscussionId": "19d1538e-bb89-4887-8a9d-e6b8dce5d6cf", - "Mappings": [] + "Mappings": [ + { + "Version": 7.0, + "Key": "studio/database/document-extensions/revisions/revisions" + } + ], + "LastSupportedVersion": 6.2 } ] diff --git a/Documentation/5.4/Raven.Documentation.Pages/studio/database/document-extensions/.docs.json b/Documentation/5.4/Raven.Documentation.Pages/studio/database/document-extensions/.docs.json index 77a96a6b33..5c48f95509 100644 --- a/Documentation/5.4/Raven.Documentation.Pages/studio/database/document-extensions/.docs.json +++ b/Documentation/5.4/Raven.Documentation.Pages/studio/database/document-extensions/.docs.json @@ -15,6 +15,12 @@ "Path": "revisions.markdown", "Name": "Revisions", "DiscussionId": "19d1538e-bb89-4887-8a9d-e6b8dce5d6cf", - "Mappings": [] + "Mappings": [ + { + "Version": 7.0, + "Key": "studio/database/document-extensions/revisions/revisions" + } + ], + "LastSupportedVersion": 6.2 } ] diff --git a/Documentation/6.0/Raven.Documentation.Pages/studio/database/document-extensions/.docs.json b/Documentation/6.0/Raven.Documentation.Pages/studio/database/document-extensions/.docs.json index 77a96a6b33..5c48f95509 100644 --- a/Documentation/6.0/Raven.Documentation.Pages/studio/database/document-extensions/.docs.json +++ b/Documentation/6.0/Raven.Documentation.Pages/studio/database/document-extensions/.docs.json @@ -15,6 +15,12 @@ "Path": "revisions.markdown", "Name": "Revisions", "DiscussionId": "19d1538e-bb89-4887-8a9d-e6b8dce5d6cf", - "Mappings": [] + "Mappings": [ + { + "Version": 7.0, + "Key": "studio/database/document-extensions/revisions/revisions" + } + ], + "LastSupportedVersion": 6.2 } ] diff --git a/Documentation/6.2/Raven.Documentation.Pages/studio/database/document-extensions/.docs.json b/Documentation/6.2/Raven.Documentation.Pages/studio/database/document-extensions/.docs.json index 77a96a6b33..85561efcf0 100644 --- a/Documentation/6.2/Raven.Documentation.Pages/studio/database/document-extensions/.docs.json +++ b/Documentation/6.2/Raven.Documentation.Pages/studio/database/document-extensions/.docs.json @@ -15,6 +15,11 @@ "Path": "revisions.markdown", "Name": "Revisions", "DiscussionId": "19d1538e-bb89-4887-8a9d-e6b8dce5d6cf", - "Mappings": [] + "Mappings": [ + { + "Version": 7.0, + "Key": "studio/database/document-extensions/revisions/revisions" + } + ] } ] diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/.docs.json b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/.docs.json index 77a96a6b33..934407d6bc 100644 --- a/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/.docs.json +++ b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/.docs.json @@ -12,7 +12,7 @@ "Mappings": [] }, { - "Path": "revisions.markdown", + "Path": "/revisions", "Name": "Revisions", "DiscussionId": "19d1538e-bb89-4887-8a9d-e6b8dce5d6cf", "Mappings": [] diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/.docs.json b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/.docs.json new file mode 100644 index 0000000000..05d8c6cb7e --- /dev/null +++ b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/.docs.json @@ -0,0 +1,31 @@ +[ + { + "Path": "revisions.markdown", + "Name": "Revisions", + "DiscussionId": "19d1538e-bb89-4887-8a9d-e6b8dce5d6cf", + "Mappings": [ + { + "Version": 6.2, + "Key": "studio/database/document-extensions/revisions" + }, + { + "Version": 6.0, + "Key": "studio/database/document-extensions/revisions" + }, + { + "Version": 5.4, + "Key": "studio/database/document-extensions/revisions" + }, + { + "Version": 5.3, + "Key": "studio/database/document-extensions/revisions" + } + ] + }, + { + "Path": "all-revisions.markdown", + "Name": "All Revisions", + "DiscussionId": "19d1538e-bb89-4887-8a9d-e6b8dce5d6cf", + "Mappings": [] + } +] diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/all-revisions.markdown b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/all-revisions.markdown new file mode 100644 index 0000000000..4c51c7104a --- /dev/null +++ b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/all-revisions.markdown @@ -0,0 +1,102 @@ +# Document Extensions: All Revisions +--- + +{NOTE: } + +* The **All Revisions** view allows you to list the + [revisions](../../../../studio/database/document-extensions/revisions/revisions) + that were created over time for all your documents. +* You can list **all** available revisions, or filter the revisions - + - By **collection** + - By **type**, selecting either revisions that indicate the **creation + or modification** of documents or revisions that indicate that documents + were **deleted**. +* All Revisions is a Studio-only feature, there is no available API for these operations. + +--- + +* In this page: + * [Opening All Revisions](../../../../studio/database/document-extensions/revisions/all-revisions#opening-all-revisions) + * [Using All Revisions](../../../../studio/database/document-extensions/revisions/all-revisions#using-all-revisions) + +{NOTE/} + +--- + +{PANEL: All Revisions} + +### Opening All Revisions + +![Open All Revisions](images/revisions/all-revisions_click-to-open-view.png "Open All Revisions") + +1. **Documents** + Click to open the Documents view. +2. **All Revisions** + Click to open All Revisions. + +--- + +### Using All Revisions + +![All Revisions](images/revisions/all-revisions.png "All Revisions") + +1. **Remove revisions** + Click to remove selected revisions (see below). + {WARNING: } + Please **be aware** that removing revisions is an **irrevocable operation**. + {WARNING/} + +2. **Info Hub** + Click for information about this view. +3. **Filter by Collection** + Click to select the collection whose revisions you want to list and manage. + + ![Filter by Collection](images/revisions/all-revisions_select-collection.png "Filter by Collection") + + To list revisions for **all** collection, leave the selection box blank + or de-select the currently selected collection. + +4. **Filter by Type** + * Filter by **All** to list **all** document revisions for the selected collection/s. + * Filter by **Regular** to list revisions that indicate the **creation** or **modification** of documents. + + ![Regular revisions](images/revisions/all-revisions_regular.png "Regular revisions") + + * Filter by **Deleted** to list revisions that indicate the **deletion** of documents. + + ![Deleted revisions](images/revisions/all-revisions_deleted.png "Deleted revisions") + +5. **Revision Selection Column** + Select revisions that you want to remove. + To remove the selected revisions, click the **Remove revisions** buttin (see above). +6. **Revision Data** + Browse for revisions' **ID**, **Collection**, **ETag**, + **Change Vector**, **Last Modification** data, and **Flags**. + - Click a revision's **ID** to visit this revision in the + [Revisions tab](../../../../studio/database/document-extensions/revisions/revisions). + - Click a revision's **Collection name** to visit this + [collection](../../../../studio/database/documents/documents-and-collections). + +{PANEL/} + + +## Related Articles + +### Document Extensions + +* [Document Revisions Overview](../../../../document-extensions/revisions/overview) +* [Revert Revisions](../../../../document-extensions/revisions/revert-revisions) +* [Revisions and Other Features](../../../../document-extensions/revisions/revisions-and-other-features) + +### Client API + +* [Revisions: API Overview](../../../../document-extensions/revisions/client-api/overview) +* [Configuring Revisions](../../../../document-extensions/revisions/client-api/operations/configure-revisions) +* [Session: Loading Revisions](../../../../document-extensions/revisions/client-api/session/loading) +* [Session: Including Revisions](../../../../document-extensions/revisions/client-api/session/including) +* [Session: Counting Revisions](../../../../document-extensions/revisions/client-api/session/counting) + +### Studio + +* [Revisions](../../../../studio/database/document-extensions/revisions/revisions) +* [Settings: Document Revisions](../../../../studio/database/settings/document-revisions) diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/all-revisions.png b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/all-revisions.png new file mode 100644 index 0000000000..4701ea0289 Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/all-revisions.png differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/all-revisions_click-to-open-view.png b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/all-revisions_click-to-open-view.png new file mode 100644 index 0000000000..00ced6ae23 Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/all-revisions_click-to-open-view.png differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/all-revisions_deleted.png b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/all-revisions_deleted.png new file mode 100644 index 0000000000..f149384067 Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/all-revisions_deleted.png differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/all-revisions_regular.png b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/all-revisions_regular.png new file mode 100644 index 0000000000..97abe00775 Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/all-revisions_regular.png differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/all-revisions_select-collection.png b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/all-revisions_select-collection.png new file mode 100644 index 0000000000..5c6e01248f Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/all-revisions_select-collection.png differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/click-revision.png b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/click-revision.png new file mode 100644 index 0000000000..2db760aea2 Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/click-revision.png differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/click-to-compare.png b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/click-to-compare.png new file mode 100644 index 0000000000..8b302f71bf Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/click-to-compare.png differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/compare-with-drop-list.png b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/compare-with-drop-list.png new file mode 100644 index 0000000000..f351b0e8ab Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/compare-with-drop-list.png differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/document-revisions.png b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/document-revisions.png new file mode 100644 index 0000000000..1f7685e81c Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/document-revisions.png differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/orphaned-revisions.png b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/orphaned-revisions.png new file mode 100644 index 0000000000..ac799fc204 Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/orphaned-revisions.png differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/restored-revisions.png b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/restored-revisions.png new file mode 100644 index 0000000000..a5cfc3d67e Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/restored-revisions.png differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/revision-comparison.png b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/revision-comparison.png new file mode 100644 index 0000000000..e3c1053192 Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/revision-comparison.png differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/revision-inspection.png b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/revision-inspection.png new file mode 100644 index 0000000000..ecfea6f827 Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/revision-inspection.png differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/revisions-bin.png b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/revisions-bin.png new file mode 100644 index 0000000000..f54c3a66d8 Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/revisions-bin.png differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/snagx/all-revisions.snagx b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/snagx/all-revisions.snagx new file mode 100644 index 0000000000..946ac2a3d0 Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/snagx/all-revisions.snagx differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/snagx/all-revisions_click-to-open-view.snagx b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/snagx/all-revisions_click-to-open-view.snagx new file mode 100644 index 0000000000..9826e37939 Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/snagx/all-revisions_click-to-open-view.snagx differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/snagx/all-revisions_select-collection.snagx b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/snagx/all-revisions_select-collection.snagx new file mode 100644 index 0000000000..91ad4a06d3 Binary files /dev/null and b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/images/revisions/snagx/all-revisions_select-collection.snagx differ diff --git a/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/revisions.markdown b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/revisions.markdown new file mode 100644 index 0000000000..17f4414959 --- /dev/null +++ b/Documentation/7.0/Raven.Documentation.Pages/studio/database/document-extensions/revisions/revisions.markdown @@ -0,0 +1,175 @@ +# Document Extensions: Revisions +--- + +{NOTE: } + +* **Document Revisions** are snapshots of documents that can be created manually or automatically when a document is created, modified, or deleted. + Revisions can be used for data auditing, instant restoration after document corruption, and other purposes. + +* Learn more about document revisions in this [document revisions overview](../../../../document-extensions/revisions/overview): + * To define and enable revisions creation, see [revisions configuration](../../../../document-extensions/revisions/overview#revisions-configuration). + * A dynamic walkthrough demonstrating revisions management is available [here](../../../../document-extensions/revisions/overview#how-it-works). + +* This article provides an overview of the Studio views related to working with revisions, including: + * Viewing revisions + * Comparing revisions + * Viewing revisions for deleted documents (Revisions Bin) + +--- + +* In this page: + * [Revisions Tab](../../../../studio/database/document-extensions/revisions/revisions#revisions-tab) + * [Revision inspection](../../../../studio/database/document-extensions/revisions/revisions#revision-inspection) + * [Revisions comparison](../../../../studio/database/document-extensions/revisions/revisions#revisions-comparison) + * [Revisions Bin](../../../../studio/database/document-extensions/revisions/revisions#revisions-bin) + * [Restoring revisions](../../../../studio/database/document-extensions/revisions/revisions#restoring-revisions) + +{NOTE/} + +--- + +{PANEL: Revisions Tab} + +* Located within the Document View, + the Revisions Tab displays the full trail of all revisions created for the document. +* From this tab, you can inspect each revision, manually force the creation of a new revision, + and compare revisions to the live document version and to other revisions. + +![Revisions Tab](images/revisions/document-revisions.png "Revisions Tab") + +1. [Document View](../../../../studio/database/documents/document-view) > **Revisions tab** + Click to display the document's revisions tab. + Revisions are listed in the revisions tab by their creation time signatures. + The current number of revisions is displayed in the tab header. +2. **Create revision** + Click to manually create a new revision for this document from the Studio. + A new revision will be created if the document doesn't already have a revision for the latest content. + [Learn here](../../../../document-extensions/revisions/overview#force-revision-creation-via-the-client-api) about forcing the creation of a new revision via the Client API. +3. **Revision timestamp** + Click to inspect this revision. +4. **Compare revision** + Click to compare this revision with the current live version of the document and with other revisions. + +{PANEL/} + +{PANEL: Revision inspection} + +Click the revision timestamp to inspect the revision's contents: + +![Click to Inspect](images/revisions/click-revision.png "Click to Inspect") + +--- + +The revision will be visible in the Document View, +but file editing will Not be available since revisions cannot be modified. + +![Revision Inspection](images/revisions/revision-inspection.png "Revision Inspection") + +1. **Revision** + The REVISION label indicates that you are viewing a revision and not + the parent document. +2. **Clone** + Click to create a document that copies the revision's contents. + {INFO: } + * Cloning the revision will open the 'new document view' with this revision's contents. + * You can then save the clone under a new name to create a new document. + * Saving the clone with the exact same ID as the revision's parent document will revert the document to this revision. + {INFO/} +3. **See the current document** + Click to return to the revision's parent document view. +4. **Revision contents** + The content of the revision is displayed in read-only mode. + +{PANEL/} + + +{PANEL: Revisions comparison} + +Click the revision's comparison button to compare it with other revisions: + +![Click to Compare](images/revisions/click-to-compare.png "Click to Compare") + +--- + +![Revision Comparison](images/revisions/revision-comparison.png "Revision Comparison") + +1. **Exit revisions compare mode** + Click to exit the comparison window and return to the revisions tTab in the Document View. +2. **Compare with** + Click to select a revision to compare with. + ![Compare-with Drop List](images/revisions/compare-with-drop-list.png "Compare-with Drop List") +3. **Left-hand revision** + The left-hand view displays the revision selected in the revisions tab. +4. **Right-hand revision** + The right-hand view displays the revision selected using the "Compare with" drop-down list. +5. **Summary line** + This line summarizes the differences found between the two revisions. + +{PANEL/} + +{PANEL: Revisions Bin} + +* This view displays the revisions of deleted documents. + +* When a document is deleted: + * A "delete-revision" is created for the document, marking its deletion. + * The "delete-revision" and all the document's revisions - whether automatically created due to the defined revisions configuration or manually created - are moved to the Revisions Bin. + * This applies regardless of whether a [revisions configuration](../../../../document-extensions/revisions/overview#revisions-configuration) is enabled or disabled. + +![Revisions Bin](images/revisions/revisions-bin.png "Revisions Bin") + +1. **Revisions Bin** + Click to open the Revisions Bin view. + Each item listed in the Revisions Bin view references all the revisions created for a deleted document. +2. **Selection boxes** + Check to select items. +3. **Delete** + Click to remove selected items. + Deleting revisions from the Revisions Bin will permanently dispose of these revisions, + making them irrecoverable. +4. **Deleted document ID** + This is the ID of the document that was deleted. + Click it to inspect the revisions created for this document, + known as "orphaned revisions" since their parent document has been deleted. + ![Orphaned Revisions](images/revisions/orphaned-revisions.png "Orphaned Revisions") + * Revisions stored in the revisions bin can be [inspected](../../../../studio/database/document-extensions/revisions/revisions#revision-inspection) + and cloned just like the revisions of a live document. +5. **Change vector** + The change vector of the revision that was created for the document when it was deleted. +6. **Deletion date** + The date/time when the document was deleted. + +--- + +### Restoring revisions + +Giving a **new document** the ID of a deleted document whose revisions are kept in the Revisions Bin, +will restore the revisions from the bin and add them to the new document. + +Opening the document's revisions tab will display the whole audit trail, +including the delete-revision created when the old document was deleted and the revision created when the new document was created. + +![Restored Revisions](images/revisions/restored-revisions.png "Restored Revisions") + +{PANEL/} + +## Related Articles + +### Document Extensions + +* [Document Revisions Overview](../../../../document-extensions/revisions/overview) +* [Revert Revisions](../../../../document-extensions/revisions/revert-revisions) +* [Revisions and Other Features](../../../../document-extensions/revisions/revisions-and-other-features) + +### Client API + +* [Revisions: API Overview](../../../../document-extensions/revisions/client-api/overview) +* [Operations: Configuring Revisions](../../../../document-extensions/revisions/client-api/operations/configure-revisions) +* [Session: Loading Revisions](../../../../document-extensions/revisions/client-api/session/loading) +* [Session: Including Revisions](../../../../document-extensions/revisions/client-api/session/including) +* [Session: Counting Revisions](../../../../document-extensions/revisions/client-api/session/counting) + +### Studio + +* [Settings: Document Revisions](../../../../studio/database/settings/document-revisions) +* [All Revisions](../../../../studio/database/document-extensions/revisions/all-revisions)