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

Registry report requirements #725

Closed
chrisn opened this issue Mar 30, 2023 · 9 comments
Closed

Registry report requirements #725

chrisn opened this issue Mar 30, 2023 · 9 comments
Labels
Closed: Question answered Used when the discussion has reached a conclusion, but wasn't an actual issue against the Process. Commenter Response Pending

Comments

@chrisn
Copy link
Member

chrisn commented Mar 30, 2023

The requirements for publishing a registry report or registry section includes:

Clearly label the registry report/section, its tables, and its registry definitions as such, including a link to §6.5 The Registry Track in this Process.

Why do registry reports and not other W3C Technical Reports (Rec or Note track reports) need to include a link to the relevant Process section? Is this requirement necessary for registries or could it be relaxed?

For context, see discussion in w3c/webcodecs#644 (although the conversation there relates more to tooling and whether there's a need for a "draft registry" document status).

@dwsinger
Copy link
Contributor

I think we wanted, at least for a while, to differentiate Registries (as defined in the Process) from registries that are already being run on previous un-definitions, that's all. So, something like "This section defines the Registry for synthetic fur colors".

@chrisn
Copy link
Member Author

chrisn commented Mar 30, 2023

Thank you, that makes perfect sense.

@tidoust
Copy link
Member

tidoust commented Mar 31, 2023

While the Process itself does not require a link in all cases, publication rules do, see for instance https://www.w3.org/pubrules/doc/rules/?profile=WD#publish

The link required by publication rules in the Status of This Document section is to 6.1 Types of Technical Reports.

The Process rather requires an explicit link to 6.5 The Registry track for Registries. Question is: can we consider that the link to 6.1 in the SOTD meets (at least the spirit of) this requirement? If so, could the requirement be relaxed in the Process?

Publication rules could perhaps be amended otherwise. This is being tracked in w3c/specberus#1713

@frivoal frivoal added this to the Deferred milestone Mar 31, 2023
@frivoal frivoal added Closed: Question answered Used when the discussion has reached a conclusion, but wasn't an actual issue against the Process. Commenter Response Pending labels Apr 19, 2024
@frivoal
Copy link
Collaborator

frivoal commented Apr 19, 2024

@chrisn, based on your response in #725 (comment), I think you're ok with closing this issue as a question answered. Could you confirm?

@chrisn
Copy link
Member Author

chrisn commented Apr 19, 2024

My question was answered, but the one @tidoust raises still needs addressing. I suggest that the existing link to 6.1 (as applied by the current publication rules) should be enough, as the text in SOTD clearly identifies the document is on the Registry Track, and 6.1 links through to 6.5.

@frivoal
Copy link
Collaborator

frivoal commented Apr 19, 2024

I think linking to 6.1 from SOTD may be alright for Registry reports. I'm not sure the indirection is helpful, but I don't think I'd object.

For the registry tables and registry definitions of an embedded registry, linking to something as generic as 6.1 doesn't seem very helpful. That said, I don't think pubrules can reasonably check for that. The consequence is rather the other way around: if a portion of a REC track document was intended to be (part of) an embedded registry, but forgot to spell it out (including the link), then it is governed by the usual REC track rules, without registry specific provisions.

@chrisn
Copy link
Member Author

chrisn commented Apr 19, 2024

The main benefit of the indirection seems to be not requiring a change to the publication rules for registry reports, but I can see the complexity with embedded registries, and I agree linking to 6.1 there is less helpful.

The other route, of course, is to update the publication rules as suggested in #725 (comment), without changes to the Process.

@frivoal frivoal added Proposed to close Agenda+ Marks issues that are ready for discussion on the call labels Oct 23, 2024
@css-meeting-bot
Copy link
Member

The Revising W3C Process CG just discussed Registry report requirements, and agreed to the following:

  • RESOLVED: Close #725
The full IRC log of that discussion <fantasai> Subtopic: Registry report requirements
<fantasai> RESOLVED: Close #725
<fantasai> github: https://github.com//issues/725

@css-meeting-bot css-meeting-bot removed the Agenda+ Marks issues that are ready for discussion on the call label Nov 13, 2024
@css-meeting-bot
Copy link
Member

The Revising W3C Process CG just discussed Charter creation, and agreed to the following:

  • RESOLVED: Close #650 as already resolved
The full IRC log of that discussion <fantasai> Subtopic: Charter creation
<fantasai> github: https://github.com//issues/725
<fantasai> RESOLVED: Close #650 as already resolved

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Closed: Question answered Used when the discussion has reached a conclusion, but wasn't an actual issue against the Process. Commenter Response Pending
Projects
None yet
Development

No branches or pull requests

6 participants