Skip to content

Latest commit

 

History

History
84 lines (57 loc) · 3.59 KB

w3c.json.md

File metadata and controls

84 lines (57 loc) · 3.59 KB
title toc
The w3c.json file
false

Projects operating under the w3c organisation (or related to W3C even if under other umbrellas) are encouraged to specify a w3c.json 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 variety of tools layered atop the organisation. They can also help humans figure out who to contact for a given problem.

Here is an example:

{
    "group":     "wg/webrtc"
,   "contacts":  ["dontcallmedom"]
,   "repo-type": "rec-track"
}

The fields that are understood at this point are:

group : The "/"-separated concatenation of group-type ("wg", "cg", "ig", "bg", "tf", "other") and shortname of the group or task force in charge of this repository. If the repository is not linked to any group, do not include that field. If the repository is linked to multiple groups, use an array.

"group": ["wg/css", "other/tag", "tf/i18n-jlreq"]

contacts : 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 GitHub ID.

repo-type : 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:

rec-track : W3C Recommendation Track documents including First Public Working Draft, Working Draft, Candidate Recommendation, Proposed Recommendation and W3C Recommendation

note : W3C Note Track documents including Group Draft Note, Group Note and Statement

registry : W3C Registry Track documents including Draft Registry, Candidate Registry, Candidate Registry Draft, and Registry

cg-report : W3C Community Group Report

tests : Test suite work

process : Work around W3C Process document, charters, policies

workshop : Management of W3C workshops

homepage : Groups' homepages

translation : Translation of a spec or other documents

article : Non-spec documents

tool : Development of tools

project : Group-independent projects

others : Other purposes

policy : This is essentially a W3C-internal flag. If set to open, any W3C Team member should feel empowered to help with the management of this given repository. This can be set to restricted 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 open.

exposed : This flag indicates if a repository gets exposed in the W3C group pages. By default, all public repositories will get exposed (exposed:true) and all private repositories will not get exposed (exposed:false).

Tooling {#tools}

There is a variety of tools using the w3c.json files.

Groups

The tools pages of all of the W3C related groups, such as WICG or VC are generated using the compiled set of w3c.json files. See also the w3c/groups README.