@recaptime-dev's working patches + fork for Phorge, a community fork of Phabricator. (Upstream dev and stable branches are at upstream/main and upstream/stable respectively.)
hq.recaptime.dev/wiki/Phorge
phorge
phabricator
Update Phriction documentation for drafts
Summary: Depends on D19668. Ref T13197. See PHI840. This updates the documentation to describe how drafts work in more detail.
Test Plan: Read documentation.
Reviewers: amckinley
Reviewed By: amckinley
Maniphest Tasks: T13197
Differential Revision: https://secure.phabricator.com/D19669
+74
-1
+74
-1
src/docs/user/userguide/phriction.diviner
+74
-1
src/docs/user/userguide/phriction.diviner
···
6
6
Overview
7
7
========
8
8
9
-
Phriction is a simple wiki. You can edit pages, and the text you write will stay
9
+
Phriction is a wiki. You can edit pages, and the text you write will stay
10
10
there. Other people can see it later.
11
+
12
+
Phriction documents are arranged in a hierarchy, like a filesystem. This can
13
+
make it easier to keep things organized and to apply policy controls to
14
+
groups of documents.
15
+
16
+
17
+
Policies
18
+
========
19
+
20
+
Documents and policies in Phriction are hierarchical, similar to a filesystem.
21
+
For example, a document called "Zebra Information" may be located
22
+
at `/zoo/animals/zebra/`.
23
+
24
+
To view a document in Phrction, you must first be able to view all of its
25
+
ancestors. So a user can only see {nav Zoo > Animals > Zebra Information} if
26
+
they can see the pages {nav Zoo} and {nav Zoo > Animals}.
27
+
28
+
This allows sections of the wiki to be restricted by applying a restrictive
29
+
policy to the parent (or grandparent) document. For example, if you apply a
30
+
restrictive view policy to the {nav Zoo} page, it will implicitly apply to
31
+
all sub-pages, including {nav Zoo > Animals > Zebra Information}.
32
+
33
+
34
+
Versions and Drafts
35
+
===================
36
+
37
+
Document content is tracked with linear version numbers: version 1, version 2,
38
+
version 3, and so on. Each time a page is edited, a new version of the page is
39
+
created.
40
+
41
+
You can {nav View History} to review older versions of a page and see how it
42
+
has changed over time (and who has changed it).
43
+
44
+
When you visit a particular document, you are normally shown the most recent
45
+
version of that document. For example, if there are 17 versions, you'll see
46
+
version 17.
47
+
48
+
Likewise, when you edit a document using {nav Edit Document > Save and Publish},
49
+
your changes are published immediately. If there were previously 17 versions,
50
+
your new changes will become version 18 and visitors to the document will begin
51
+
seeing version 18.
52
+
53
+
If you want to edit a document without publishing the changes right away, you
54
+
can use {nav Edit Document > Save as Draft} instead. This will still create a
55
+
new version 18, but it won't change which version users see when they visit the
56
+
document: they'll still see version 17 (the last published version).
57
+
58
+
You (and other users) can continue editing the draft by using
59
+
{nav Edit Document}. (Once a document has an unpublished draft, editing will
60
+
stay in draft mode.)
61
+
62
+
Once you're satisfied with your changes, use {nav Publish Draft} to make your
63
+
changes the current visible version of the document that users see by default
64
+
when they visit it.
65
+
66
+
If you made a mistake and published something you didn't intend to, you can
67
+
navigate back to an older version of the document and use
68
+
{nav Publish Older Version} to change the current visible version of the
69
+
document to some older version.
70
+
71
+
Note that draft versions are still normal versions of the document: they are
72
+
not private, they can not be deleted, other users can see them if they can see
73
+
the document, and they will eventually become a standard part of the document
74
+
history. The only private parts of drafts are: editing a draft does not
75
+
generate a feed story; and users won't see draft content by default when
76
+
viewing a document.
77
+
78
+
Drafts may be a good fit if you are:
79
+
80
+
- working on changes over time; or
81
+
- starting with a rough change and refining it in several iterations; or
82
+
- collaborating with others on a change; or
83
+
- sharing changes before they're published to get feedback.