|
|
| Line 1: |
Line 1: |
| The [[Baloo]] system requires a unified schema for contribution activity description | | The [[Baloo]] system requires a unified schema for contribution activity description |
|
| |
|
| == Contributions == | | == Versions == |
| | The current version can be found here: |
| | [[Baloo/Schema/0.1|Version 0.1]] |
|
| |
|
| All contribution data follows this schema:
| | == Contact == |
| <ul>
| | All development discussions are happening in the [https://mail.mozilla.org/listinfo/community-building Community Building] mailing list under [Systems] tag. |
| <li><code>guid</code>: Globally Unique Identifier of the contribution (string)</li>
| | We also hang out at #baloo in IRC |
| <li><code>email</code>: email address of contributor (string)</li>
| |
| <li><code>datetime</code>: date and time of contribution (datetime)</li>
| |
| <li><code>canonical</code>: permanent URL to contribution (string)</li>
| |
| <li><code>volunteer</code>: boolean value indicating paid employee status (boolean)</li>
| |
| <li><code>type</code>: a codified string that describes the contribution (string)
| |
| <li><code>source</code>: source of contribution, one of the following: (string)
| |
| <ul><li>bugzilla</li><li>hg</li><li>sumo</li>
| |
| </ul>
| |
| </li>
| |
| <li><code>extra</code>: per-contribution data, following a source-dependent schema (dictionary)</li>
| |
| </ul>
| |
| | |
| === extra - Bugzilla === | |
| <ul>
| |
| <li><code>fields</code>: fields modified (list of string)</li>
| |
| <li><code>values</code>: values of modified fields, where available. Keys correspond to names of modified fields. (dictionary)</li>
| |
| <li><code>id</code>: bug id (integer)</li>
| |
| <li><code>product</code>: product (string)</li>
| |
| <li><code>component</code>: component (string)</li>
| |
| <li><code>new</code>: new bug creation (boolean, optional)</li>
| |
| <li><code>firstpatch</code>: first patch flag (boolean, optional [likely doesn't work])</li>
| |
| <li><code>comment</code>: associated comment ID (integer, optional)</li>
| |
| <li><code>review</code>: review flag was modified (set, cleared, changed, etc) (boolean, optional)</li>
| |
| <li><code>feedback</code>: feedback flag was modified (set, cleared, changed, etc) (boolean, optional)</li>
| |
| <li><code>needinfo</code>: needinfo flag was modified (set, cleared, changed, etc) (boolean, optional)</li>
| |
| </ul>
| |
| | |
| === extra - hg ===
| |
| <ul>
| |
| <li><code>tree</code>: tree name (eg. mozilla-central) (string)</li>
| |
| <li><code>sha</code>: revision hash (string, doesn't exist yet)</li>
| |
| </ul>
| |
| | |
| === extra - sumo ===
| |
| <ul>
| |
| <li><code>type</code>: type of SUMO contribution, one of: (string)
| |
| <ul><li>answer</li><li>post</li><li>discuss</li><li>revision</li></ul></li>
| |
| <li><code>locale</code>: locale of contribution (string)</li>
| |
| </ul>
| |
| | |
| ==== extra - sumo - answer ====
| |
| <ul>
| |
| <li><code>question</code>: id of answered question (integer)</li>
| |
| <li><code>id</code>: id of answer (integer)</li>
| |
| <li><code>product</code>: associated product slug (string)</li>
| |
| <li><code>topic</code>: associated topic slug (string)</li>
| |
| </ul>
| |
| | |
| ==== extra - sumo - post ====
| |
| <ul>
| |
| <li><code>thread</code>: id of associated forum thread (integer)</li>
| |
| <li><code>id</code>: id of post (integer)</li>
| |
| <li><code>slug</code>: associated forum slug (string)</li>
| |
| </ul>
| |
| | |
| ==== extra - sumo - discuss ====
| |
| <ul>
| |
| <li><code>article</code>: id of associated article (integer)</li>
| |
| <li><code>thread</code>: id of associated discussion thread (integer)</li>
| |
| <li><code>id</code>: id of post (integer)</li>
| |
| <li><code>new</code>: new post, or edit of existing (boolean)</li>
| |
| <li><code>slug</code>: associated article slug (string)</li>
| |
| </ul>
| |
| | |
| ==== extra - sumo - revision ====
| |
| <ul>
| |
| <li><code>article</code>: id of associated article (integer)</li>
| |
| <li><code>id</code>: id of revision (integer)</li>
| |
| <li><code>slug</code>: associated article slug (string)</li>
| |
| </ul>
| |
| | |
| === extra - reps (planned) ===
| |
| <ul>
| |
| <li><code>report-date</code>: when the contribution was reported (datetime)</li>
| |
| <li><code>report-type</code>: type of report (string)</li>
| |
| <li><code>campaign</code>: campaign that the contribution supports (string)</li>
| |
| <li><code>contribution-areas</code>: contribution areas that are supported by this contribution (string)</li>
| |
| <li><code>location</code>: location (latitude, longitude?)</li>
| |
| <li><code>extra</code>: additional text about the contribution (string)</li>
| |
| <li><code>url</code>: canonical URL for the activity (string)</li></ul>
| |
| | |
| | |
| <!--
| |
| == Entrypoints ==
| |
| Data representing first contact points for potential contributors. These may not actually be first contact, but the are places where first contact often occurs.
| |
| | |
| All entrypoint data follows this schema:
| |
| <ul>
| |
| <li><code>email</code>: email address of contactee (string)</li>
| |
| <li><code>datetime</code>: date and time of contact (datetime)</li>
| |
| <li><code>canonical</code>: permanent URL to point of contact (string)</li>
| |
| <li><code>source</code>: source of contact, one of the following: (string)
| |
| <ul><li>contribute</li><li>sumo</li>
| |
| </ul>
| |
| </li>
| |
| <li><code>extra</code>: per-entrypoint data, following a source-dependent schema (dictionary)</li>
| |
| </ul>
| |
| | |
| ==== extra - contribute ====
| |
| <ul>
| |
| <li><code>interest</code>: category selected for interest (eg. Coding, Web Development, etc.) (string)</li>
| |
| </ul>
| |
| | |
| ==== extra - sumo ====
| |
| <ul>
| |
| <li><code>id</code>: id of new question (integer)</li>
| |
| <li><code>product</code>: name of product (string)</li>
| |
| <li><code>category</code>: name of category (string)</li>
| |
| </ul>
| |
| | |
| -->
| |