Merge pull request #84 from creative-commoners/docs/userguide

DOCS Add simple userguide and images
silverstripe · Jun 25, 2018 · 12f7884 · 12f7884
2 parents f3d1e69 + 761d385
commit 12f7884
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 0 deletions.
diff --git a/docs/en/images/share_draft_frontend.png b/docs/en/images/share_draft_frontend.png
diff --git a/docs/en/images/share_draft_popover.png b/docs/en/images/share_draft_popover.png
diff --git a/docs/en/userguide/index.md b/docs/en/userguide/index.md
@@ -0,0 +1,23 @@
+title: Share draft content
+summary: Share draft page content with non-CMS users.
+
+# Share draft content
+
+The [Share draft content](https://github.com/silverstripe/silverstripe-sharedraftcontent/) module provides the ability for SilverStripe users to share draft page content with non-CMS users.
+
+This enables CMS users to generate a private link which can be shared securely with anyone. Each preview link is valid for 30 days.
+
+![Share draft content CMS view](../images/share_draft_popover.png)
+
+## Viewing the shared draft page
+
+Navigating to the shared link will allow you to view the draft state of the page.
+
+<div class="note" markdown="1">If you navigate away from the shared draft page you will be taken to the published state.</div>
+
+Pages appear in two states:
+* Draft state contains content which is yet to be published. While viewing draft pages, a message will appear to inform you of this.
+
+* Published state contains content which has been published. As a result, you will not be notified of this, and will see the live version of the site.
+
+![Share draft content front-end alert](../images/share_draft_frontend.png) <!-- to do update images when UI has been updated -->