-
Notifications
You must be signed in to change notification settings - Fork 37
/
w3c.json.html
151 lines (131 loc) · 5.53 KB
/
w3c.json.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>The w3c.json file</title>
<link rel="stylesheet" href="css/wgio.css">
</head>
<body>
<header>
<h1>The <code>w3c.json</code> file</h1>
</header>
<nav>
<a href="/">Home</a>
•
<a href="https://github.com/w3c/">Repositories</a>
•
<a href="https://help.github.com/">GitHub Help</a>
</nav>
<main>
<p>
Projects operating under the <code>w3c</code> organisation (or related to W3C even if under
other umbrellas) are encouraged to specify a <code>w3c.json</code> file at the root of their
repository. The purpose of this file is to provide some metadata about repositories so that
they can be processed automatically by a <a href='#tools'>variety of tools</a> layered atop
the organisation.
They can also help humans figure out who to contact for a given problem.
</p>
<p>
Here is an example:
</p>
<pre>{
"group": "wg/webrtc"
, "contacts": ["dontcallmedom"]
, "repo-type": "rec-track"
}</pre>
<p>
The fields that are understood at this point are:
</p>
<dl>
<dt id="group" data-type="number|array<number>|string|array<string>"><code>group</code></dt>
<dd>
The "/"-seperated concatenation of group-type ("wg", "cg", "ig", "bg") and shortname (alternatively, the numeric ID) of the group in charge of this repo. If the repo is not linked to any group, do not include that field.
<br />
<br />
<strong>Note:</strong> If the group is actually a joint task
force of more than group, please specify all the shortnames of the
groups consist of the task force as an array, e.g.:
<br />
<pre>"group": ["wg/css", "wg/svg"]</pre>
</dd>
<dt id="contacts" data-type="array<string>"><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.
For integration purposes, please use your <em>GitHub</em> ID.
</dd>
<dt id="repo-type" data-type="string|array<string>"><code>repo-type</code></dt>
<dd>
String to identify the type and purpose of the repository, or an array of such strings if the repository holds more than one type of content.
The possible values for this field are:<br/><br/>
<dl>
<dt class="value">rec-track</dt>
<dd>W3C Recommendation Track Documents including First Public
Working Draft, Working Draft, Candidate Recommendation, Proposed
Recommendation and W3C Recommendation</dd>
<dt class="value">note</dt>
<dd>W3C Note Track including Group Draft Note, Group Note and Statement</dd>
<dt class="value">registry</dt>
<dd>W3C Registry Track including Draft Registry, Candidate Registry, Candidate Registry Draft, and Registry</dd>
<dt class="value">cg-report</dt>
<dd>W3C Community Group Report</dd>
<dt class="value">tests</dt>
<dd>Test suite work</dd>
<dt class="value">process</dt>
<dd>Work around W3C Process document, charters, policies</dd>
<dt class="value">workshop</dt>
<dd>Repo to manage W3C workshops</dd>
<dt class="value">homepage</dt>
<dd>Groups' homepages</dd>
<dt class="value">translation</dt>
<dd>Repo hosting translation of a spec or other documents</dd>
<dt class="value">article</dt>
<dd>Non-spec documents</dd>
<dt class="value">tool</dt>
<dd>Development of tools</dd>
<dt class="value">project</dt>
<dd>Group-independent projects</dd>
<dt class="value">others</dt>
<dd>Other purposes</dd>
</dl>
</dd>
<dt id="policy" data-type="string"><code>policy</code></dt>
<dd>
This is essentially a W3C-internal flag. If set to <code class="value">open</code>, any W3C Team member
should feel empowered to help with the management of this given repository. This can be
set to <code class="value">restricted</code> to indicate that for whatever reason, it is preferable to
let the repository be handled only by team contacts directly associated with it. The
default value is <code>open</code>.
</dd>
<dt id="exposed" data-type="boolean"><code>exposed</code></dt>
<dd>
This flag indicates if a repository gets exposed in the <a href='https://www.w3.org/groups/'>W3C group pages</a>.
By default, all public repositories will get exposed (<code>exposed:true</code>) and all private repositories
will not get exposed (<code>exposed:false</code>).
</dd>
</dl>
<h2 id="tools">Tooling</h2>
<p>
There is a variety of tools using the <code>w3c.json</code> files.
</p>
<h3>Groups</h3>
<p>
The tools pages of all of the W3C related groups, such as
<a href="https://www.w3.org/groups/cg/wicg/tools/">WICG</a> or
<a href="https://www.w3.org/groups/wg/vc/tools/">VC</a> are generated using the
<a href="https://w3c.github.io/groups/repositories.json">compiled set
of <code>w3c.json</code> files</a>. See also the <a
href="https://github.com/w3c/groups/blob/main/README.md">w3c/groups README</a>.
</p>
</main>
<footer>
<address><a href="https://github.com/w3c/w3c.github.io/">We are on GitHub</a></address>
<p>
<a href="https://www.w3.org/"><img src="img/w3c.svg" width="65" height="45" alt="W3C Logo"></a>
</p>
</footer>
</body>
</html>