phorge-phorge/src/docs/user/userguide/phame.diviner

@title Phame User Guide
@group userguide

Journal about your thoughts and feelings. Share with others. Profit.

= Overview =

IMPORTANT: Phame is a prototype application.

Phame is a simple blogging platform. You can write drafts which only you can
see. Later, you can publish these drafts as posts which anyone who can access
the Phabricator instance can see. You can also add posts to blogs to increase
your distribution.

Overall, Phame is intended to help an individual spread their message. As
such, pertinent design decisions skew towards favoring the individual
rather than the collective.

= Drafts =

Drafts are completely private so draft away.

= Posts =

Posts are accessible to anyone who has access to the Phabricator instance.

= Blogs =

Blogs are collections of posts. Each blog has associated metadata like
a name, description, and set of bloggers who can add posts to the blog.
Each blogger can also edit metadata about the blog and delete the blog
outright.

NOTE: removing a blogger from a given blog does not remove their posts that
are already associated with the blog. Rather, it removes their ability to edit
metadata about and add posts to the blog.

Blogs can be useful for powering external websites, like

  blog.yourcompany.com

by making pertinent configuration changes with your DNS authority and
Phabricator instance. For the Phabricator instance, you must

 - Enable `policy.allow-public` in Phabricator configuration.
 - Configure the blog to have the view policy `public`.

For your DNS authority, simply point the pertinent domain name at your
Phabricator instance. e.g. by IP address.

= Comment Widgets =

Phame supports comment widgets from Facebook and Disqus. The administrator
of the Phabricator instance must properly configure Phabricator to enable
this functionality.

A given comment widget is tied 1:1 with a given post. This means the same
instance of a given comment widget will appear for a given post regardless
of whether that post is being viewed in the context of a blog.
Phame V1 - Phabricator blogging software Summary: 'cuz we need to be phamous! V1 feature set - posts -- standard thing you'd expect - a title and a remarkup-powered body and... -- "phame" title - a short string that can be used to reference the story. this gets auto-updated when you mess with the title. -- configuration - for now, do you want Facebook, Disqus or no comments? this is a per-post thing but feeds from an instance-wide configuration Please do toss out any must have features or changes. Test Plan: played around with this bad boy like whoa Reviewers: epriestley Reviewed By: epriestley CC: aran, vrana Maniphest Tasks: T1111 Differential Revision: https://secure.phabricator.com/D2202 2012-04-12 22:09:04 +02:00			`@title Phame User Guide`
			`@group userguide`

			`Journal about your thoughts and feelings. Share with others. Profit.`

			`= Overview =`

Remove scattered links to "Support" document Summary: I'm going to do some version of D13941. Clean up extra links to the old document first. These were just randomly links from various places that we no longer really want feedback on and/or are now better covered by other documents. Test Plan: - `grep` - Reviewed Config/Welcome screen. - Reviewed `uri.allowed-editor-protocols`. Reviewers: chad Reviewed By: chad Differential Revision: https://secure.phabricator.com/D14303 2015-10-19 22:27:47 +02:00			`IMPORTANT: Phame is a prototype application.`

Phame V1 - Phabricator blogging software Summary: 'cuz we need to be phamous! V1 feature set - posts -- standard thing you'd expect - a title and a remarkup-powered body and... -- "phame" title - a short string that can be used to reference the story. this gets auto-updated when you mess with the title. -- configuration - for now, do you want Facebook, Disqus or no comments? this is a per-post thing but feeds from an instance-wide configuration Please do toss out any must have features or changes. Test Plan: played around with this bad boy like whoa Reviewers: epriestley Reviewed By: epriestley CC: aran, vrana Maniphest Tasks: T1111 Differential Revision: https://secure.phabricator.com/D2202 2012-04-12 22:09:04 +02:00			`Phame is a simple blogging platform. You can write drafts which only you can`
Phame - introduce blogs Summary: blogs are collections of posts. a blog also has metadata like a name, description and "bloggers" that can edit the metadata of the blog and contribute posts. changes include the post edit flow where bloggers can now select which blogs to publish to. also made various small tweaks throughout the UI to make things sensical and clean as the concept of blogs is introduced. there's edges powering this stuff. bloggers <=> blogs and posts <=> blogs in particular. Test Plan: made blogs, deleted blogs, tried to make blogs with no bloggers. all went well. verified ui to publish only showed up for public posts, published posts to blogs, un-published posts to blogs, re-published posts to blogs, deleted posts and verified they disappeared from blogs. Reviewers: epriestley Reviewed By: epriestley CC: aran, Korvin Maniphest Tasks: T1373 Differential Revision: https://secure.phabricator.com/D3003 2012-07-19 18:03:10 +02:00			`see. Later, you can publish these drafts as posts which anyone who can access`
Various linter fixes. Summary: - Removed trailing newlines. - Added newline at EOF. - Removed leading newlines. - Trimmed trailing whitespace. - Spelling fix. - Added newline at EOF Test Plan: N/A Reviewers: epriestley, #blessed_reviewers Reviewed By: epriestley CC: hach-que, chad, Korvin, epriestley, aran Differential Revision: https://secure.phabricator.com/D8344 2014-02-26 21:44:58 +01:00			`the Phabricator instance can see. You can also add posts to blogs to increase`
Phame - introduce blogs Summary: blogs are collections of posts. a blog also has metadata like a name, description and "bloggers" that can edit the metadata of the blog and contribute posts. changes include the post edit flow where bloggers can now select which blogs to publish to. also made various small tweaks throughout the UI to make things sensical and clean as the concept of blogs is introduced. there's edges powering this stuff. bloggers <=> blogs and posts <=> blogs in particular. Test Plan: made blogs, deleted blogs, tried to make blogs with no bloggers. all went well. verified ui to publish only showed up for public posts, published posts to blogs, un-published posts to blogs, re-published posts to blogs, deleted posts and verified they disappeared from blogs. Reviewers: epriestley Reviewed By: epriestley CC: aran, Korvin Maniphest Tasks: T1373 Differential Revision: https://secure.phabricator.com/D3003 2012-07-19 18:03:10 +02:00			`your distribution.`

Various linter fixes. Summary: - Removed trailing newlines. - Added newline at EOF. - Removed leading newlines. - Trimmed trailing whitespace. - Spelling fix. - Added newline at EOF Test Plan: N/A Reviewers: epriestley, #blessed_reviewers Reviewed By: epriestley CC: hach-que, chad, Korvin, epriestley, aran Differential Revision: https://secure.phabricator.com/D8344 2014-02-26 21:44:58 +01:00			`Overall, Phame is intended to help an individual spread their message. As`
Phame - introduce blogs Summary: blogs are collections of posts. a blog also has metadata like a name, description and "bloggers" that can edit the metadata of the blog and contribute posts. changes include the post edit flow where bloggers can now select which blogs to publish to. also made various small tweaks throughout the UI to make things sensical and clean as the concept of blogs is introduced. there's edges powering this stuff. bloggers <=> blogs and posts <=> blogs in particular. Test Plan: made blogs, deleted blogs, tried to make blogs with no bloggers. all went well. verified ui to publish only showed up for public posts, published posts to blogs, un-published posts to blogs, re-published posts to blogs, deleted posts and verified they disappeared from blogs. Reviewers: epriestley Reviewed By: epriestley CC: aran, Korvin Maniphest Tasks: T1373 Differential Revision: https://secure.phabricator.com/D3003 2012-07-19 18:03:10 +02:00			`such, pertinent design decisions skew towards favoring the individual`
Various linter fixes. Summary: - Removed trailing newlines. - Added newline at EOF. - Removed leading newlines. - Trimmed trailing whitespace. - Spelling fix. - Added newline at EOF Test Plan: N/A Reviewers: epriestley, #blessed_reviewers Reviewed By: epriestley CC: hach-que, chad, Korvin, epriestley, aran Differential Revision: https://secure.phabricator.com/D8344 2014-02-26 21:44:58 +01:00			`rather than the collective.`
Phame - introduce blogs Summary: blogs are collections of posts. a blog also has metadata like a name, description and "bloggers" that can edit the metadata of the blog and contribute posts. changes include the post edit flow where bloggers can now select which blogs to publish to. also made various small tweaks throughout the UI to make things sensical and clean as the concept of blogs is introduced. there's edges powering this stuff. bloggers <=> blogs and posts <=> blogs in particular. Test Plan: made blogs, deleted blogs, tried to make blogs with no bloggers. all went well. verified ui to publish only showed up for public posts, published posts to blogs, un-published posts to blogs, re-published posts to blogs, deleted posts and verified they disappeared from blogs. Reviewers: epriestley Reviewed By: epriestley CC: aran, Korvin Maniphest Tasks: T1373 Differential Revision: https://secure.phabricator.com/D3003 2012-07-19 18:03:10 +02:00
			`= Drafts =`

Various linter fixes. Summary: - Removed trailing newlines. - Added newline at EOF. - Removed leading newlines. - Trimmed trailing whitespace. - Spelling fix. - Added newline at EOF Test Plan: N/A Reviewers: epriestley, #blessed_reviewers Reviewed By: epriestley CC: hach-que, chad, Korvin, epriestley, aran Differential Revision: https://secure.phabricator.com/D8344 2014-02-26 21:44:58 +01:00			`Drafts are completely private so draft away.`
Phame - introduce blogs Summary: blogs are collections of posts. a blog also has metadata like a name, description and "bloggers" that can edit the metadata of the blog and contribute posts. changes include the post edit flow where bloggers can now select which blogs to publish to. also made various small tweaks throughout the UI to make things sensical and clean as the concept of blogs is introduced. there's edges powering this stuff. bloggers <=> blogs and posts <=> blogs in particular. Test Plan: made blogs, deleted blogs, tried to make blogs with no bloggers. all went well. verified ui to publish only showed up for public posts, published posts to blogs, un-published posts to blogs, re-published posts to blogs, deleted posts and verified they disappeared from blogs. Reviewers: epriestley Reviewed By: epriestley CC: aran, Korvin Maniphest Tasks: T1373 Differential Revision: https://secure.phabricator.com/D3003 2012-07-19 18:03:10 +02:00
Various linter fixes. Summary: - Removed trailing newlines. - Added newline at EOF. - Removed leading newlines. - Trimmed trailing whitespace. - Spelling fix. - Added newline at EOF Test Plan: N/A Reviewers: epriestley, #blessed_reviewers Reviewed By: epriestley CC: hach-que, chad, Korvin, epriestley, aran Differential Revision: https://secure.phabricator.com/D8344 2014-02-26 21:44:58 +01:00			`= Posts =`
Phame - introduce blogs Summary: blogs are collections of posts. a blog also has metadata like a name, description and "bloggers" that can edit the metadata of the blog and contribute posts. changes include the post edit flow where bloggers can now select which blogs to publish to. also made various small tweaks throughout the UI to make things sensical and clean as the concept of blogs is introduced. there's edges powering this stuff. bloggers <=> blogs and posts <=> blogs in particular. Test Plan: made blogs, deleted blogs, tried to make blogs with no bloggers. all went well. verified ui to publish only showed up for public posts, published posts to blogs, un-published posts to blogs, re-published posts to blogs, deleted posts and verified they disappeared from blogs. Reviewers: epriestley Reviewed By: epriestley CC: aran, Korvin Maniphest Tasks: T1373 Differential Revision: https://secure.phabricator.com/D3003 2012-07-19 18:03:10 +02:00
			`Posts are accessible to anyone who has access to the Phabricator instance.`

			`= Blogs =`

			`Blogs are collections of posts. Each blog has associated metadata like`
			`a name, description, and set of bloggers who can add posts to the blog.`
			`Each blogger can also edit metadata about the blog and delete the blog`
			`outright.`

Phame - add some application polish. Summary: Fixes T4880. More specifically - adds an "edit" pencil to post lists iff you can edit the post - style change so this has no text-decoration - adds a "no data" box if you have no posts in a given view - style change to crush some margins so it formats like posts do - adds some validation that your configuration is correct if you are specifying a custom domain - updates docs about custom domains Test Plan: clicked around and it was better! (see screenshots) read doc changes carefully Reviewers: epriestley, chad Reviewed By: epriestley Subscribers: epriestley, Korvin Maniphest Tasks: T4880 Differential Revision: https://secure.phabricator.com/D8918 2014-04-30 22:19:14 +02:00			`NOTE: removing a blogger from a given blog does not remove their posts that`
			`are already associated with the blog. Rather, it removes their ability to edit`
			`metadata about and add posts to the blog.`

			`Blogs can be useful for powering external websites, like`
Phame - introduce blogs Summary: blogs are collections of posts. a blog also has metadata like a name, description and "bloggers" that can edit the metadata of the blog and contribute posts. changes include the post edit flow where bloggers can now select which blogs to publish to. also made various small tweaks throughout the UI to make things sensical and clean as the concept of blogs is introduced. there's edges powering this stuff. bloggers <=> blogs and posts <=> blogs in particular. Test Plan: made blogs, deleted blogs, tried to make blogs with no bloggers. all went well. verified ui to publish only showed up for public posts, published posts to blogs, un-published posts to blogs, re-published posts to blogs, deleted posts and verified they disappeared from blogs. Reviewers: epriestley Reviewed By: epriestley CC: aran, Korvin Maniphest Tasks: T1373 Differential Revision: https://secure.phabricator.com/D3003 2012-07-19 18:03:10 +02:00
			`blog.yourcompany.com`

Various linter fixes. Summary: - Removed trailing newlines. - Added newline at EOF. - Removed leading newlines. - Trimmed trailing whitespace. - Spelling fix. - Added newline at EOF Test Plan: N/A Reviewers: epriestley, #blessed_reviewers Reviewed By: epriestley CC: hach-que, chad, Korvin, epriestley, aran Differential Revision: https://secure.phabricator.com/D8344 2014-02-26 21:44:58 +01:00			`by making pertinent configuration changes with your DNS authority and`
Phame - add some application polish. Summary: Fixes T4880. More specifically - adds an "edit" pencil to post lists iff you can edit the post - style change so this has no text-decoration - adds a "no data" box if you have no posts in a given view - style change to crush some margins so it formats like posts do - adds some validation that your configuration is correct if you are specifying a custom domain - updates docs about custom domains Test Plan: clicked around and it was better! (see screenshots) read doc changes carefully Reviewers: epriestley, chad Reviewed By: epriestley Subscribers: epriestley, Korvin Maniphest Tasks: T4880 Differential Revision: https://secure.phabricator.com/D8918 2014-04-30 22:19:14 +02:00			`Phabricator instance. For the Phabricator instance, you must`
Phame - introduce blogs Summary: blogs are collections of posts. a blog also has metadata like a name, description and "bloggers" that can edit the metadata of the blog and contribute posts. changes include the post edit flow where bloggers can now select which blogs to publish to. also made various small tweaks throughout the UI to make things sensical and clean as the concept of blogs is introduced. there's edges powering this stuff. bloggers <=> blogs and posts <=> blogs in particular. Test Plan: made blogs, deleted blogs, tried to make blogs with no bloggers. all went well. verified ui to publish only showed up for public posts, published posts to blogs, un-published posts to blogs, re-published posts to blogs, deleted posts and verified they disappeared from blogs. Reviewers: epriestley Reviewed By: epriestley CC: aran, Korvin Maniphest Tasks: T1373 Differential Revision: https://secure.phabricator.com/D3003 2012-07-19 18:03:10 +02:00
Phame - add some application polish. Summary: Fixes T4880. More specifically - adds an "edit" pencil to post lists iff you can edit the post - style change so this has no text-decoration - adds a "no data" box if you have no posts in a given view - style change to crush some margins so it formats like posts do - adds some validation that your configuration is correct if you are specifying a custom domain - updates docs about custom domains Test Plan: clicked around and it was better! (see screenshots) read doc changes carefully Reviewers: epriestley, chad Reviewed By: epriestley Subscribers: epriestley, Korvin Maniphest Tasks: T4880 Differential Revision: https://secure.phabricator.com/D8918 2014-04-30 22:19:14 +02:00			- Enable `policy.allow-public` in Phabricator configuration.
			- Configure the blog to have the view policy `public`.

			`For your DNS authority, simply point the pertinent domain name at your`
			`Phabricator instance. e.g. by IP address.`
Phame V1 - Phabricator blogging software Summary: 'cuz we need to be phamous! V1 feature set - posts -- standard thing you'd expect - a title and a remarkup-powered body and... -- "phame" title - a short string that can be used to reference the story. this gets auto-updated when you mess with the title. -- configuration - for now, do you want Facebook, Disqus or no comments? this is a per-post thing but feeds from an instance-wide configuration Please do toss out any must have features or changes. Test Plan: played around with this bad boy like whoa Reviewers: epriestley Reviewed By: epriestley CC: aran, vrana Maniphest Tasks: T1111 Differential Revision: https://secure.phabricator.com/D2202 2012-04-12 22:09:04 +02:00
			`= Comment Widgets =`

Fixed typo in Phame user guide Summary: adminstrator → administrator Test Plan: read again the sencence Reviewers: btrahan, #blessed_reviewers, epriestley Reviewed By: #blessed_reviewers, epriestley Subscribers: epriestley Differential Revision: https://secure.phabricator.com/D10904 2014-11-26 14:07:37 +01:00			`Phame supports comment widgets from Facebook and Disqus. The administrator`
Phame V1 - Phabricator blogging software Summary: 'cuz we need to be phamous! V1 feature set - posts -- standard thing you'd expect - a title and a remarkup-powered body and... -- "phame" title - a short string that can be used to reference the story. this gets auto-updated when you mess with the title. -- configuration - for now, do you want Facebook, Disqus or no comments? this is a per-post thing but feeds from an instance-wide configuration Please do toss out any must have features or changes. Test Plan: played around with this bad boy like whoa Reviewers: epriestley Reviewed By: epriestley CC: aran, vrana Maniphest Tasks: T1111 Differential Revision: https://secure.phabricator.com/D2202 2012-04-12 22:09:04 +02:00			`of the Phabricator instance must properly configure Phabricator to enable`
			`this functionality.`

Phame - introduce blogs Summary: blogs are collections of posts. a blog also has metadata like a name, description and "bloggers" that can edit the metadata of the blog and contribute posts. changes include the post edit flow where bloggers can now select which blogs to publish to. also made various small tweaks throughout the UI to make things sensical and clean as the concept of blogs is introduced. there's edges powering this stuff. bloggers <=> blogs and posts <=> blogs in particular. Test Plan: made blogs, deleted blogs, tried to make blogs with no bloggers. all went well. verified ui to publish only showed up for public posts, published posts to blogs, un-published posts to blogs, re-published posts to blogs, deleted posts and verified they disappeared from blogs. Reviewers: epriestley Reviewed By: epriestley CC: aran, Korvin Maniphest Tasks: T1373 Differential Revision: https://secure.phabricator.com/D3003 2012-07-19 18:03:10 +02:00			`A given comment widget is tied 1:1 with a given post. This means the same`
			`instance of a given comment widget will appear for a given post regardless`
			`of whether that post is being viewed in the context of a blog.`