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

add repo-type to identify the type and purpose of the repositories #53

Merged
merged 2 commits into from
Oct 2, 2018

Conversation

ashimura
Copy link
Contributor

Based on the discussion with Philippe and Dom, I've added an additional field to identify the type and purpose of the GitHub repositories: "rec-track", "note", "cg-report", "process", "homepage", "tool", "project" and "others".

Also added a note that we can use an array to specify multiple groups when the target group is actually a joint task force which includes more than one group.

@ylafon
Copy link
Member

ylafon commented Sep 24, 2018

Could you also have something to distinguish between one repo for one spec, or one repo for multiple specs? The proposal seems to imply one specification per repository and it is not always the case.

@plehegar
Copy link
Member

we discussed the idea of adding support for "one repo for multiple specs" but we stopped since we didn't know how useful this would be. For example, if you say "rec-track", the IP manager knows enough to track contributions.

@ylafon
Copy link
Member

ylafon commented Sep 25, 2018

if you have rec-track docs and a wg note (not on PP), how do you track only the relevant contributions?

@plehegar
Copy link
Member

the idea is to use the more important one. If your repo contain a REC-track doc and a non-REC-track one, we need to worry about the REC-track one first, thus you'd use "rec-track". Yes, the IP manager will flag pull requests for non-REC track docs but, until we revise the IP manager, there is no way around, independently of the w3c.json.

@ylafon
Copy link
Member

ylafon commented Sep 25, 2018

Fair enough, could it be a RFE for the next iteration of it?

@plehegar
Copy link
Member

yes, definitively. We didn't a showstopper in the current proposal to add support for multiple content in a one repo in the future.

Copy link
Member

@tripu tripu left a comment

Choose a reason for hiding this comment

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

I'm okay with this extension to w3c.json (but see comments inline).

Thinking of repos containing software, yes, we need a way to identify them. I don't mind whether that is because they will never include a w3c.json file, or because they will have it but it will contain some specific value in the field repo-type.

About repos used for more than one spec: I thought we mostly discouraged those. Automatic publication as part of CI, for example, becomes more cumbersome and complex to maintain. Are you aware of many repos like that?

w3c.json.html Outdated
<strong>Note:</strong> If the group is actually a joint task
force of more than group, please specify all the IDs of the
groups consist of the task force as an array, e.g.:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;"group": ["35422", "83907"]
Copy link
Member

Choose a reason for hiding this comment

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

  • Wrap this line of JSON in a <pre>, as in the example above.
  • If we expect numeric IDs, and the example above uses a number type (not a string), these IDs here should be number, too (ie, remove the quotation marks).

Copy link
Contributor Author

@ashimura ashimura Oct 2, 2018

Choose a reason for hiding this comment

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

OK

I'll wrap the example line with "<pre>".

Also I'm fine with using "number" (=removing the quotation marks).

@tripu
Copy link
Member

tripu commented Sep 26, 2018

(Pinging @deniak explicitly to get his comments; specifically about the field group containing more than one group ID and possible implications in Echidna.)

@plehegar
Copy link
Member

+1 on promoting one spec per repo.
re on a single repo containing multiple documents, we have a few, Here are what I'm aware of:

I suspect we could make a split for some but not all, eg csswg-drafts.

@dontcallmedom
Copy link
Member

re repos with multiple specs under different IPR regimes in the repo manager, there is already an open issue on this fwiw w3c/ash-nazg#125

@deniak
Copy link
Member

deniak commented Sep 27, 2018

(Pinging @deniak explicitly to get his comments; specifically about the field group containing more than one group ID and possible implications in Echidna.)

This shouldn't be a problem for Echidna. It can already deal with multiple deliverers.

@plehegar
Copy link
Member

it would be good to identify non-TR documents. I wonder if that goes under "note" or a new one. The EO WG is producing a lot of articles on GH and we should integrate that fact into our tools.

@tripu tripu merged commit 38568c5 into master Oct 2, 2018
@tripu tripu deleted the add-repo-type branch October 2, 2018 07:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants