Skip to content

Commit

Permalink
Mention versioned snapshots in the versions documentation (#9057)
Browse files Browse the repository at this point in the history
* Mention versioned snapshots in the versions documentation

* Add screenshot
  • Loading branch information
dnsl48 authored and Aaron Carlino committed Jun 16, 2019
1 parent 1fc94ec commit 2e33456
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/en/02_Developer_Guides/00_Model/10_Versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,22 @@ from published content shown to your website visitors.

Versioning in SilverStripe is handled through the [Versioned](api:SilverStripe\Versioned\Versioned) class. As a [DataExtension](api:SilverStripe\ORM\DataExtension) it is possible to be applied to any [DataObject](api:SilverStripe\ORM\DataObject) subclass. The extension class will automatically update read and write operations done via the ORM via the `augmentSQL` database hook.

<div class="notice" markdown="1">
There are two complementary modules that improve content editor experience around "owned" nested objects (e.g. elemental blocks).
Those are in experimental status right now, but we would appreciate any feedback and contributions.

You can check them out on github:
- https://github.com/silverstripe/silverstripe-versioned-snapshots
- https://github.com/silverstripe/silverstripe-versioned-snapshot-admin

The first one adds extra metadata to versions about object parents at the moment of version creation.
The second module extends CMS History UI adding control over nested objects.

<img width="600" src="../../_images/snapshot-admin.png" width="600">

*Example screenshot from versioned-snapshot-admin*
</div>

## Understanding versioning concepts

This section discuss how SilverStripe implements versioning and related high level concepts without digging into technical details.
Expand Down
Binary file added docs/en/_images/snapshot-admin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2e33456

Please sign in to comment.