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.

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

Update Status of This Document #47

Closed
anssiko opened this issue Feb 2, 2015 · 2 comments
Closed

Update Status of This Document #47

anssiko opened this issue Feb 2, 2015 · 2 comments
Assignees
Milestone

Comments

@anssiko
Copy link
Member

anssiko commented Feb 2, 2015

The "Status of This Document" section should be updated before we publish FPWD:

http://w3c.github.io/presentation-api/#sotd

IIRC @tidoust volunteered to take this.

@anssiko anssiko added this to the FPWD milestone Feb 2, 2015
@anssiko
Copy link
Member Author

anssiko commented Feb 2, 2015

Before we publish FPWD, I believe it would be helpful to note in the Status of The Document section [1] that the group uses GitHub for issue tracking. Currently, the spec has 27 open issues in GitHub [2]. Some issues are inline in the spec to provide more context around them (and that's fine), thus it may not be obvious to people outside the group reviewing the spec that they should also be looking at GitHub issues. I suggest we keep the "Participate" header too, perhaps make it a list as some other specs have done with appropriate pointers, such as:

Participate:
Mailing list
GitHub repository
Open issues
Commit history

Secondly, to set the expectations with regard to maturity, we could state something like:

This document is not complete and is subject to change. Feedback from early experimentations is
encouraged to allow the Second Screen Presentation Working Group evolve the specification based on implementation feedback.

[1] http://w3c.github.io/presentation-api/#sotd
[2] https://github.com/w3c/presentation-api/issues

tidoust added a commit to tidoust/presentation-api that referenced this issue Feb 4, 2015
This new paragraph mentions the provenance of the spec, most important change
since publication by the CG, alerts users about missing or incomplete parts,
and invites them to check the list of issues on GitHub.

It builds on the text proposed by @anssiko.
tidoust added a commit that referenced this issue Feb 4, 2015
Added a custom paragraph in Status of This Document section (#47)
@mfoltzgoogle
Copy link
Contributor

The following text has been added to the Status of The Document to reflect that GH is the source of truth for open issues.

This document is a work in progress and is subject to change. It builds on the final report (dated 18 November 2014) produced by the Second Screen Presentation Community Group
...
A few open issues are noted inline. Please check the group's issue tracker on GitHub for an accurate list.

Therefore, closing this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants