Skip to content

Latest commit

 

History

History
25 lines (15 loc) · 1.74 KB

README.md

File metadata and controls

25 lines (15 loc) · 1.74 KB
Raw

cg-reports

This repository is for W3C Community and Business Groups to manage and publish final reports. These reports are expected to comply with the CG Report Requirements.

Reports managed through this repository are mirrored on w3.org. Once a document appears on w3.org, it can be registered in the W3C system as a Final Specification; see more about how to publish a report.

Usage

To publish a final report.

  1. If your document is developed using ReSpec, please provide the static output rather than the dynamic source file. For example: export static html report via respec menu

  2. Open a pull request that provides the report content under a directory with the following convention: <cgshortname>/CG-FINAL-<reportshortname>-<YYYYMMDD>/ where <cgshortname> is the shortname of the group, <reportshortname> is a name of the group's choosing (particularly useful if the group manages several reports), and <YYYYMMDD> is the publication date.

  3. Ensure this directory contains a single index.html file.

Once merged by the W3C Community Lead, that content will then be available under the URL https://www.w3.org/community/reports/<cgshortname>/CG-FINAL-<reportshortname>-<YYYYMMDD>/.

Once published, per the Community Group Process, the document at this URI must not change.

Check

The W3C CG Support team typically verifies that CG reports use the right naming conventions and the valid template (CG logo, no W3C logo, SOTD disclaimer).