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

Draft boilerplate text #243

Merged
merged 9 commits into from
Jul 21, 2023
Merged

Draft boilerplate text #243

merged 9 commits into from
Jul 21, 2023

Conversation

nigelmegitt
Copy link
Contributor

@nigelmegitt nigelmegitt commented Feb 9, 2023

Resolves #242 by adding draft boilerplate text.

Verified

This commit was signed with the committer’s verified signature.
@nigelmegitt nigelmegitt self-assigned this Feb 9, 2023
@nigelmegitt nigelmegitt linked an issue Feb 9, 2023 that may be closed by this pull request
@@ -0,0 +1,4 @@
{
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file should be named as boilerplate/registry/.pr-preview.json instead of placed at the top directory?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't know that could work. There's an index.html in the top directory too, which is for the TTWG homepage. I've added .pr-preview.json to the location you suggested as well. But I think PR Preview only does one preview per repo, as far as I know. tobie/pr-preview#18 is open to support multiple specs per repo, but as you can see from the response to my comment, it's awaiting resource.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I thought this boilerplate/registry directory was for ready-to-copy respec template to create new repository (e.g. making new repository like w3c/tt-profile-registry). If so, this file should be at the same directory as this template, but not at the top of this repository. OR, If this PR is really to put at the top of this repository with pointing index.html, I propose to use html for type, instead of respec.
As pointed, pr-preview does handle only one file in each repository, yes.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a good point, having the .pr-preview.json file there does no harm, I think, and means there is something ready to copy. I think it's fine to leave it there and keep the type as respec, while understanding that PR Preview won't actually work with it in the current location.

* Link from TTWG to its home page
* Add Custodianship section
* Add Change Process section
* Improve definitions and links
* Editorial clarification of registry entry status changes
* Include index of defined terms
* Add appendix with checklist for applying the boilerplate
@nigelmegitt nigelmegitt marked this pull request as ready for review February 28, 2023 15:09
Addresses review feedback regarding the reference to W3C Team.
@nigelmegitt
Copy link
Contributor Author

Current snapshot (won't auto-update): https://ttml.w3c.himor.in/boilerplate-registry-20230316.html

@css-meeting-bot
Copy link
Member

The Timed Text Working Group just discussed Registries, and agreed to the following:

  • SUMMARY: TTWG call 2023-07-20: merge this pull request
The full IRC log of that discussion <nigel> Subtopic: Registries
<cpn> Nigel: A long time ago, I created a boilerplate registry, in the TTWG repo PR 243
<nigel> github: https://github.com//pull/243
<cpn> Nigel: As there's been no comments, and all comments resolved, so I propose to merge the PR, and then create registries based on this: two for DAPT
<cpn> ... Need to work out how, either as separate documents or directly inside DAPT
<cpn> ... Unless you want more time to review, I propose merging
<nigel> cpn: The only thing in my mind was about editor's drafts of draft registry status,
<nigel> .. in Respec. Did you make any progress with that?
<nigel> Nigel: I didn't do anything about that!
<nigel> .. It's a good point
<nigel> Chris: It's a separate issue.
<nigel> Atsushi: I suppose WebCodecs registry is using slimline publication that we are using for DAPT,
<nigel> .. where they auto-publish to /TR on merge
<nigel> .. If so, there's no difference between ED and the published one on /TR so the state of ED for Draft Registries
<nigel> .. is not needed.
<nigel> cpn: Here, you haven't decided if the Registry is a separate document or within the spec itself.
<nigel> Nigel: Yes
<nigel> Chris: No need to delay it on my account then - that was my only question.
<nigel> Nigel: Anyone else?
<nigel> group: No
<nigel> SUMMARY: TTWG call 2023-07-20: merge this pull request

@nigelmegitt nigelmegitt merged commit fb28a74 into main Jul 21, 2023
@nigelmegitt
Copy link
Contributor Author

Merged as per decision during call 2023-07-20 #256 .

@nigelmegitt nigelmegitt deleted the issue-0242-registry-boilerplate branch July 21, 2023 16:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Documents
Development

Successfully merging this pull request may close these issues.

Draft boilerplate Registry text
3 participants