Plugins:PluginDirectory/EditingWorkflow: Difference between revisions
LesOrchard (talk | contribs) (Created page with 'The Plugin Directory offers editorial workflows for: * accepting suggested updates to plugin releases from anonymous users; * review and acceptance of suggestes updates by users…') |
LesOrchard (talk | contribs) No edit summary |
||
| Line 13: | Line 13: | ||
; guest : anonymous user, not logged in | ; guest : anonymous user, not logged in | ||
; member : registered user, logged in | ; member : registered user, logged in | ||
; trusted : user assigned "editor" access to a subset of plugins by PFS ID (ie. a vendor, with access to manage their own plugins) | ; trusted : (''not yet implemented'') user assigned "editor" access to a subset of plugins by PFS ID (ie. a vendor, with access to manage their own plugins) | ||
; editor : user with read/write/deploy access to plugin releases in all sandboxes | ; editor : user with read/write/deploy access to plugin releases in all sandboxes | ||
; admin : user with full read/write/delete access to both live and sandboxed plugin releases | ; admin : user with full read/write/delete access to both live and sandboxed plugin releases | ||
| Line 19: | Line 19: | ||
== Anonymous submissions == | == Anonymous submissions == | ||
Visitors to the front page of the site are offered a list of detected plugins | Visitors to the front page of the site are offered a list of detected plugins | ||
paired with status in the directory. This status can be one of unknown, | |||
in | latest, outdated, vulnerable, newer, or uncertain. | ||
status can be one of unknown, latest, outdated, vulnerable, newer, or uncertain. | |||
Each detected plugin offers a link to an anonymous submission form. A visitor | Each detected plugin offers a link to an anonymous submission form. A visitor | ||
| Line 33: | Line 32: | ||
queue. Each submission can be converted into a new plugin or a release added | queue. Each submission can be converted into a new plugin or a release added | ||
to an existing plugin in a sandbox. From there, the information can be revised | to an existing plugin in a sandbox. From there, the information can be revised | ||
until it's | until it's ready to push live. | ||
== Sandbox editing == | == Sandbox editing == | ||
All registered users have a personal sandbox. Any live plugin and associated | All registered users have a personal sandbox. Any live plugin and associated | ||
releases can be copied to this sandbox | releases can be copied to this sandbox. The user owning the sandbox has full | ||
editing access to the data therein. Normal users cannot see other users' | editing access to the data therein. Normal users cannot see other users' | ||
sandboxes. | sandboxes. | ||
| Line 53: | Line 52: | ||
Once satisfied with the edits, the user can then request approval for the changes, | Once satisfied with the edits, the user can then request approval for the changes, | ||
which sends out an email to site editors to review the sandbox changes. | which sends out an email to site editors wit a link to review the sandbox changes. | ||
== Editor approval == | == Editor approval == | ||
Users with "editor" access have the ability to view any user's sandbox. From there, | Users with "editor" access have the ability to view/edit/delete data in any | ||
they can review sandboxed plugins, perform edits, and deploy a sandbox plugin live. | user's sandbox. From there, they can review sandboxed plugins, perform edits, | ||
and deploy a sandbox plugin live. | |||
Deploying a sandboxed plugin live overwrites the live data and makes the changes | Deploying a sandboxed plugin live overwrites the live data and makes the changes | ||
Revision as of 17:47, 9 February 2010
The Plugin Directory offers editorial workflows for:
- accepting suggested updates to plugin releases from anonymous users;
- review and acceptance of suggestes updates by users with "editor" access and above;
- allowing editing of plugin releases in personal sandboxes for any registered user;
- reviewing and deploying plugin releases in sandboxes by users with "editor" access and above;
This page offers some more details on how this works.
Access levels
- guest
- anonymous user, not logged in
- member
- registered user, logged in
- trusted
- (not yet implemented) user assigned "editor" access to a subset of plugins by PFS ID (ie. a vendor, with access to manage their own plugins)
- editor
- user with read/write/deploy access to plugin releases in all sandboxes
- admin
- user with full read/write/delete access to both live and sandboxed plugin releases
Anonymous submissions
Visitors to the front page of the site are offered a list of detected plugins paired with status in the directory. This status can be one of unknown, latest, outdated, vulnerable, newer, or uncertain.
Each detected plugin offers a link to an anonymous submission form. A visitor can use this form to provide corrections in case:
- displayed plugin details are incorrect;
- he/she has information about a plugin unknown to the directory;
- or he/she has installed a plugin update not yet known to the directory.
These form submissions are viewable by users with "editor" access in a review queue. Each submission can be converted into a new plugin or a release added to an existing plugin in a sandbox. From there, the information can be revised until it's ready to push live.
Sandbox editing
All registered users have a personal sandbox. Any live plugin and associated releases can be copied to this sandbox. The user owning the sandbox has full editing access to the data therein. Normal users cannot see other users' sandboxes.
When a user is logged in, plugin data from his/her sandbox takes priority on the front page over live data. This allows the user to preview edits to the sandox data with respect to detected installed plugins.
So, for example, consider the case where live data reports that a given installed plugin is newer than the directory's entry. The user can copy that plugin to his/her sandbox, edit the details to match the updated plugin, and then visit the front page to verify that the new plugin version is correctly detected as the latest using the sandbox data.
Once satisfied with the edits, the user can then request approval for the changes, which sends out an email to site editors wit a link to review the sandbox changes.
Editor approval
Users with "editor" access have the ability to view/edit/delete data in any user's sandbox. From there, they can review sandboxed plugins, perform edits, and deploy a sandbox plugin live.
Deploying a sandboxed plugin live overwrites the live data and makes the changes available to all users via the PFS search API.
Users with "editor" access cannot create/edit/delete live plugins directly.
Trusted users
This is not yet implemented.
Trusted users are assigned "editor" level access to specific plugins. This is most useful for vendors, giving them self-service access to their own plugins.