spec/README
author rbachman2
Mon, 07 Mar 2011 15:18:18 +0100
changeset 137 eea7b8afca21
parent 116 9564023406d3
permissions -rw-r--r--
ACTION-15: a raw scheletto for an architecture document
     1 Abstract
     2 --------
     3 WebID 1.0
     4 Web Identification and Discovery
     5 
     6 Identification and privacy have been at the center of how we interact with sites
     7 on the Web. The explosion of Websites over the last decade and a half has
     8 created a point of pain for anyone that uses the Web on a regular basis.
     9 Remembering login details, passwords, and sharing private information across the
    10 many websites that people use on a daily basis has become more difficult and
    11 complicated than necessary. This specification outlines a simple universal
    12 identification mechanism that is distributed, openly extensible, improves
    13 privacy, security and control over how one can identify themselves and control
    14 access to their information on the Web.
    15 
    16 Source
    17 ------
    18 
    19 You can read, branch and modify the source code for this specification via the
    20 main WebID hg repository hosted by the W3C:
    21 
    22 https://dvcs.w3.org/hg/WebID
    23 
    24 For those more familiar with git, a secondary repository is kept in sync on
    25 github: https://github.com/webid-community/webid-spec
    26 
    27 Feedback
    28 --------
    29 
    30 Send an email to the WebID XG public mailing list if you want to request changes
    31 to the spec, it is the only way you can make sure that your input will be
    32 tracked and considered by the group:
    33 
    34 http://lists.w3.org/Archives/Public/public-xg-webid/
    35 
    36 A list of bugs is maintained at http://www.w3.org/2005/Incubator/webid/track/
    37 
    38 You must be a members of the WebID XG to create new bugs in the tracker, however
    39 anyone can follow up on existing issues by mentioning the issue number
    40 (e.g. WebID-ISSUE-33) in the title or the body of any email sent to the
    41 WebId XG mailing list . These emails will automatically be listed in the
    42 relevant issues in the tracker.
    43 
    44 When logging an issue, be very specific about the problem and the exact change
    45 and wording that you would like to suggest. The easier you make changing the
    46 spec, the more likely that your change will be placed into the specification.
    47 
    48 Contributing
    49 ------------
    50 
    51 To directly contribute to the specification:
    52 
    53 1. You MUST modify the 'index-respec.html' file via hg or git - it is the
    54    primary source document.
    55 2. You MUST agree to transferring the specification text to the governing
    56    specification body W3C when the time comes to transition the documents to an
    57    official specification.
    58 3. You MUST NOT add in any text that you know to be in violation of a trade
    59    secret, patent or other form of intellectual property.
    60 4. Understand that this will be a patent and royalty-free specification and no
    61    payment will be made to any of the editors, authors or contributors. That
    62    said, millions of people will be thankful for your contribution in ensuring
    63    that the web continutes to be accessible in a patent and royalty-free way.
    64 5. You will want to become familiar with ReSpec before you edit the
    65    'index-respec.html' file. Documentation for respec is available here:
    66    http://dev.w3.org/2009/dap/ReSpec.js/documentation.html
    67 6. Make small commits so that they can be reviewed more easily. Avoid mixing
    68    editorial changes and style changes in the same commit.
    69 7. The respec source document uses an 80 character line limit except for long
    70    URIs or code snippets. Trailing whitespaces should be stripped to avoid
    71    people who strip them automatically to make unintended changes when saving
    72    a file.