diff options
| author | Bryan Newbold <bnewbold@robocracy.org> | 2019-02-14 16:19:26 -0800 |
|---|---|---|
| committer | Bryan Newbold <bnewbold@robocracy.org> | 2019-02-14 16:19:26 -0800 |
| commit | 70b4bc18b13f59c9d42c8e44ef872dfd2e1abef3 (patch) | |
| tree | 1c4706394047bce6a086228e2efe8632d8bc1a23 /guide/src/workflow.md | |
| parent | 56edebe7c2e090c4f25179f03a2d77d78ba59219 (diff) | |
| download | fatcat-70b4bc18b13f59c9d42c8e44ef872dfd2e1abef3.tar.gz fatcat-70b4bc18b13f59c9d42c8e44ef872dfd2e1abef3.zip | |
more guide tweaks; not a full review/rewrite
Diffstat (limited to 'guide/src/workflow.md')
| -rw-r--r-- | guide/src/workflow.md | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/guide/src/workflow.md b/guide/src/workflow.md index 94842e54..ff1552cf 100644 --- a/guide/src/workflow.md +++ b/guide/src/workflow.md @@ -3,8 +3,8 @@ ## Basic Editing Workflow and Bots Both human editors and bots should have edits go through the same API, with -humans using either the default web interface, integration, or client -software. +humans using either the default web interface, client software, or third-party +integrations. The normal workflow is to create edits (or updates, merges, deletions) on individual entities. Individual changes are bundled into an "edit group" of @@ -12,13 +12,13 @@ related edits (eg, correcting authorship info for multiple works related to a single author). When ready, the editor "submits" the edit group for review. During the review period, human editors vote and bots can perform automated checks. During this period the editor can make tweaks if necessary. -After some fixed time period (72 hours?) with no changes and no blocking -issues, the edit group would be auto-accepted if no merge conflicts have -be created by other edits to the same entities. This process balances editing -labor (reviews are easy, but optional) against quality (cool-down period makes -it easier to detect and prevent spam or out-of-control bots). More -sophisticated roles and permissions could allow some certain humans and bots to -push through edits more rapidly (eg, importing new works from a publisher API). +After some fixed time period (one week?) with no changes and no blocking +issues, the edit group would be accepted if no merge conflicts have be created +by other edits to the same entities. This process balances editing labor +(reviews are easy, but optional) against quality (cool-down period makes it +easier to detect and prevent spam or out-of-control bots). More sophisticated +roles and permissions could allow some certain humans and bots to push through +edits more rapidly (eg, importing new works from a publisher API). Bots need to be tuned to have appropriate edit group sizes (eg, daily batches, instead of millions of works in a single edit) to make human QA review and |