Yay, there is documentation! But it's not much.

The documentation sorely needs improvement. There's a lot of edge topics to cover. Here are some thoughts off the top of my head.

  • How to set it up so you can give semi-privileged users a site version URL without giving them full site version access.
  • How to deal with edge cases of queries. (Hint: Sometimes it's accept the limitations.).
  • How to set up a site that has both CPS and non-CPS managed content. This is a philosophy thing.
  • A warning that CPS own the whole shebang, and explain to people how content that existed prior to CPS is seen.
  • A warning that with CPS, the deletion of content should be a feature that is rarely used, and instead rely on unpublishing and hiding unpublished content completely, so that the integrity of your revision history is maintained.
  • A discussion of the 'initial live revision' that gets created so people understand how new content is added to the system and how CPS keeps content that has not yet been published separate from the rest of the system, and how this can possibly leak over if the permissions are not structured correctly.
  • Clarify to users that CPS only supports entities, and any data that isn't stored in an entity will not be revisioned. In particular, this makes CPS incompatible with things like nodequeue, and an entity-based solution for nodequeues would need to be used instead. entityreference is a good alternative in many cases.

This issue can be used as a place to put more ideas so the documentation can be improved and worked upon.

Volunteers are needed!!

Comments

merlinofchaos’s picture

Issue summary: View changes
merlinofchaos’s picture

Issue summary: View changes