Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add repo-type to identify the type and purpose of the repositories #53

Merged
merged 2 commits into from
Oct 2, 2018
Merged

add repo-type to identify the type and purpose of the repositories #53

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8adea96
add repo-type
ashimura Sep 24, 2018
e85fa6e
add <pre> to the example code; also made the gid number
ashimura Oct 2, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 53 additions & 9 deletions w3c.json.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,26 +34,70 @@ <h1>The <code>w3c.json</code> file</h1>
{
"group": 40318
, "contacts": ["darobin", "sideshowbarker"]
, "repo-type": ["rec-track"]
}
</pre>
<p>
The fields that are understood at this point are:
</p>
<dl>
<dt><code>group</code></dt>
<dt id="group"><code>group</code></dt>
<dd>
The numeric ID of the group in charge of this repo. While it is inconvenient for humans to
find such IDs they are the best thing we have to programmatically create links between
repositories and a whole lot of other data we have that are using this type of identifier.
The numeric ID of the group in charge of this repo. While it is
inconvenient for humans to find such IDs they are the best thing
we have to programmatically create links between repositories
and a whole lot of other data we have that are using this type
of identifier.
<br/><br/>
<strong>Note:</strong> If the group is actually a joint task
force of more than group, please specify all the IDs of the
groups consist of the task force as an array, e.g.:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;"group": ["35422", "83907"]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Wrap this line of JSON in a <pre>, as in the example above.
  • If we expect numeric IDs, and the example above uses a number type (not a string), these IDs here should be number, too (ie, remove the quotation marks).

Copy link
Contributor Author

@ashimura ashimura Oct 2, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK

I'll wrap the example line with "<pre>".

Also I'm fine with using "number" (=removing the quotation marks).

</dd>
<dt id=contacts><code>contacts</code></dt>

<dt id="contacts"><code>contacts</code></dt>
<dd>
An array of people who are considered points of contact for the repository for
administrative requests. They aren't necessarily the primary contributor and they aren't
necessarily from the W3C Team. Whatever works for any given repository is acceptable.
An array of people who are considered points of contact for the
repository for administrative requests. They aren't necessarily
the primary contributor and they aren't necessarily from the W3C
Team. Whatever works for any given repository is acceptable.
For integration purposes, please use your <em>GitHub</em> ID.
</dd>
<dt><code>policy</code></dt>

<dt id="repo-type"><code>repo-type</code></dt>
<dd>
String to identify the type and purpose of the repository.
The possible values for this field are:<br/><br/>
<dl>
<dt>rec-track</dt>
<dd>W3C Recommendation Track Documents including First Public
Working Draft, Working Draft, Candidate Recommendation, Proposed
Recommendation and W3C Recommendation</dd>

<dt>note</dt>
<dd>W3C Group Note including Working Group Note and Interest Group Note</dd>

<dt>cg-report</dt>
<dd>W3C Community Group Report</dd>

<dt>process</dt>
<dd>Discussion on the W3C Process document</dd>

<dt>homepage</dt>
<dd>Groups' homepages</dd>

<dt>tool</dt>
<dd>Development of tools</dd>

<dt>project</dt>
<dd>Group-independent projects</dd>

<dt>others</dt>
<dd>Other purposes</dd>
</dl>
</dd>

<dt id="policy"><code>policy</code></dt>
<dd>
This is essentially a W3C-internal flag. If set to <code>open</code>, any W3C Team member
should feel empowered to help with the management of this given repository. This can be
Expand Down