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.

Sign up for GitHub

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

Jump to bottom

Move definition contrat to Spec Editors Community Group #2088

Open
dontcallmedom opened this issue Jun 17, 2021 · 3 comments
Open

Move definition contrat to Spec Editors Community Group #2088

dontcallmedom opened this issue Jun 17, 2021 · 3 comments
Labels
documentation An issue or PR about improving Bikeshed's documentation

Comments

@dontcallmedom
Copy link
Member

The bikeshed documentation is at the moment the authoritative place that specifies how definitions should be marked up.

This specification has now at least two consumer implementations (shepherd and reffy), and two or three producers (bikeshed, respec and at least some support from wattsi) and as part of our work on browser-specs and reffy, we have already identified possible clarifications needed:
w3c/reffy#336
and are interested in approaching other editing tools from other communities (TC39, IETF, Khronos) to gauge their interest in adopting it, which would probably involve expanding the taxonomy of definitions.

Given the recent launch of the Spec Editors Community Group, this would feel like a good host to maintain this definition contract as a document of its own. I'm happy to seed such a document if moving it away from the bikeshed documentation is acceptable.

cc @tidoust @marcoscaceres
@tabatkins
Copy link
Collaborator

Yup, this sounds good to me. Is the SECG a GH org (in which case I can spin the contract out into a repo) or a repo under w3c (in which case I just need edit rights)?

@dontcallmedom
Copy link
Member Author

I've created https://github.com/speced/spec-dfn-contract/ - feel free to overwrite its history

dontcallmedom added a commit to dontcallmedom/WebGL that referenced this issue Jun 22, 2021
@dontcallmedom
Markup definitions with their type
00a8d79 
As defined in the [definition markup contract](https://tabatkins.github.io/bikeshed/#dfn-contract) that many Web specs are adhering to - these conventions are not specific to bikeshed (they are [being moved to a document on their own](speced/bikeshed#2088 (comment))).

Adhering to these conventions makes it easier for other specifications to reference items defined in WebGL, through projects such as [webref](github.com/w3c/webref/) and [shepherd](http://hg.csswg.org/dev/shepherd/) which themseves are integrated in bikeshed and respec, widely used by other specs.

If this type of changes are acceptable and welcome, I would be happy to provide additional patches for other IDL items, at least those that are known to be referenced from other specs - if so, I might need guidance on what convention to follow to assign uid=1000(dom) gid=1000(dom) groupes=1000(dom),4(adm),24(cdrom),27(sudo),30(dip),44(video),46(plugdev),105(docker),113(lpadmin),128(sambashare)s to these definitions.
@dontcallmedom dontcallmedom mentioned this issue Jun 22, 2021
Merged
dontcallmedom added a commit to dontcallmedom/WebGL that referenced this issue Jun 23, 2021
@dontcallmedom
Markup definitions with their type
7c5f29f 
As defined in the [definition markup contract](https://tabatkins.github.io/bikeshed/#dfn-contract) that many Web specs are adhering to - these conventions are not specific to bikeshed (they are [being moved to a document on their own](speced/bikeshed#2088 (comment))).

Adhering to these conventions makes it easier for other specifications to reference items defined in WebGL, through projects such as [webref](github.com/w3c/webref/) and [shepherd](http://hg.csswg.org/dev/shepherd/) which themseves are integrated in bikeshed and respec, widely used by other specs.

If this type of changes are acceptable and welcome, I would be happy to provide additional patches for other IDL items, at least those that are known to be referenced from other specs - if so, I might need guidance on what convention to follow to assign uid=1000(dom) gid=1000(dom) groupes=1000(dom),4(adm),24(cdrom),27(sudo),30(dip),44(video),46(plugdev),105(docker),113(lpadmin),128(sambashare)s to these definitions.
dontcallmedom added a commit to dontcallmedom/WebGL that referenced this issue Jun 23, 2021
@dontcallmedom
Markup definitions with their type
1fe570f 
As defined in the [definition markup contract](https://tabatkins.github.io/bikeshed/#dfn-contract) that many Web specs are adhering to - these conventions are not specific to bikeshed (they are [being moved to a document on their own](speced/bikeshed#2088 (comment))).

Adhering to these conventions makes it easier for other specifications to reference items defined in WebGL, through projects such as [webref](github.com/w3c/webref/) and [shepherd](http://hg.csswg.org/dev/shepherd/) which themseves are integrated in bikeshed and respec, widely used by other specs.

If this type of changes are acceptable and welcome, I would be happy to provide additional patches for other IDL items, at least those that are known to be referenced from other specs - if so, I might need guidance on what convention to follow to assign uid=1000(dom) gid=1000(dom) groupes=1000(dom),4(adm),24(cdrom),27(sudo),30(dip),44(video),46(plugdev),105(docker),113(lpadmin),128(sambashare)s to these definitions.
dontcallmedom added a commit to dontcallmedom/WebGL that referenced this issue Jun 29, 2021
@dontcallmedom
Markup definitions with their type
225418f 
As defined in the [definition markup contract](https://tabatkins.github.io/bikeshed/#dfn-contract) that many Web specs are adhering to - these conventions are not specific to bikeshed (they are [being moved to a document on their own](speced/bikeshed#2088 (comment))).

Adhering to these conventions makes it easier for other specifications to reference items defined in WebGL, through projects such as [webref](github.com/w3c/webref/) and [shepherd](http://hg.csswg.org/dev/shepherd/) which themseves are integrated in bikeshed and respec, widely used by other specs.

If this type of changes are acceptable and welcome, I would be happy to provide additional patches for other IDL items, at least those that are known to be referenced from other specs - if so, I might need guidance on what convention to follow to assign `id`s to these definitions.
kdashg pushed a commit to KhronosGroup/WebGL that referenced this issue Jun 29, 2021
@dontcallmedom
Markup definitions with their type (#3294)
fec72ba 
As defined in the [definition markup contract](https://tabatkins.github.io/bikeshed/#dfn-contract) that many Web specs are adhering to - these conventions are not specific to bikeshed (they are [being moved to a document on their own](speced/bikeshed#2088 (comment))).

Adhering to these conventions makes it easier for other specifications to reference items defined in WebGL, through projects such as [webref](github.com/w3c/webref/) and [shepherd](http://hg.csswg.org/dev/shepherd/) which themseves are integrated in bikeshed and respec, widely used by other specs.

If this type of changes are acceptable and welcome, I would be happy to provide additional patches for other IDL items, at least those that are known to be referenced from other specs - if so, I might need guidance on what convention to follow to assign `id`s to these definitions.
@marcoscaceres
Copy link
Contributor

@tabatkins, I made a start at moving the contract over:
speced/spec-dfn-contract#10

Would be great to collaborate on it.

@jyasskin jyasskin added the documentation An issue or PR about improving Bikeshed's documentation label Dec 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation An issue or PR about improving Bikeshed's documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@jyasskin @dontcallmedom @tabatkins @marcoscaceres