Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
- Keep in mind that
doc->attributes->modifiedare READ ONLY and are automatically added by the PMP. Moreover, if you try to push a doc with values for either
doc->attributes->modified, it will fail. The only date you can/should send is
- We are still working on updating docs. One helpful hint, if you are following docs/README, and you see a 'pmp' anywhere, especially in an URN, you probably have wrong/outdated docs.
- Pushing a doc that inherits from the base profile will fail without a title. It is spelled out in the base profile docs. But keep this in mind when dealing with assets (I'm thinking images) that don't always (intrinsically and/or necessarily) have a 'title'.
- It's probably a good idea to have a way to automatically push some/all of your content. No joke! Especially given the fluid nature of the PMP, it's not hard to foresee a situation where you'll want to re-push some/all content (remove a tag, tweak an attribute, etc.).
- While the collection.doc+jSON ambiguous on the subject, if you push a doc with a GUID, it MUST be a UUIDv4 version. https://github.com/publicmediaplatform/pmpdocs/wiki/Globaly-Unique-Identifiers-for-PMP-Documents Though, oddly, the server does not strictly enforce that. Ticket: https://github.com/publicmediaplatform/pmp-issues/issues/2
- Never forget that every 'doc' is actually a collectionDoc and when you think you are grabbing a simple, comprehensive doc, you might not actually be doing that. In other words, the concept of LIMIT applies to every collectionDoc. So if you are, say, pulling down a group of orgs or even a simple story that has, say, a large slideshow of 11+ images, you could get a nasty surprise if you don't set
LIMIT = REASONABLY HIGH INT. That's because the current default of
LIMITis 10. And if you don't set a limit, you'll only get the first 10 items (along with pagination links).
- Permission Groups are groups (i.e., docs where profile = group) that are usually used to implement PMP's Role-based content rights management system. Note that a group, however, is just a collection of Users or any profile type (e.g. -- Orgs) that extends the User profile. As such, it can be created for a variety of purposes. In and of itself, a group has no explicit relation to permissions. See: https://github.com/publicmediaplatform/pmp-issues/issues/16#issuecomment-52245909
- Be careful when using blacklists. It might seem counter-intuitive, but blacklists don't work well by themselves. If you want everyone but station X to view a doc, just a blacklist won't cut it. Said doc would essentially be private. Instead, you need to attach the blacklist AND a whitelist permission to the doc. See http://cdoc.io/spec.html#a-blacklist-without-a-whitelist
- Though this still prevents you from using blacklists in the most intuitive, basic way (show it to everyone EXCEPT these users/orgs). See: https://github.com/publicmediaplatform/pmp-issues/issues/44
Clone this wiki locally
Press h to open a hovercard with more details.