search

w3c / json-ld-wg

Documentation for the JSON-LD Working Group
https://www.w3.org/2018/json-ld-wg/
Other
29 stars 24 forks source link

2020-04-24-action1: check pubrules on streaming note (Gregg Kellogg) #145

Closed iherman closed 4 years ago

iherman commented 4 years ago

check pubrules on streaming note (Gregg Kellogg) (see details)

Cc: @gkellogg

gkellogg commented 4 years ago

@iherman I'm getting some unknown issues from Pub Rules checker:

Deliverer not found. An attribute data-deliverer must be in the SotD.

I've never heard of this before; it's not set in our CR reports, and I don't see a reference to it from the ReSpec Wiki. Is there something specifically required for a WG-NOTE?

Also, the Link Checker seems to be broken.

iherman commented 4 years ago

@deniak I seem to remember that we had a problem with the data-deliverer before. Can you help, please?

gkellogg commented 4 years ago

The checker, and Pubrules 4.1.8 say that it must have data-deliverer in SOTD, and apparently with the ID of the WG, is this just "JSON-LD WG", or is there a numeric ID I need to use?

It also says that it have the name of the W3C group, which is a link. That appears in the body of the first paragraph, so I suspect that's sufficient.

iherman commented 4 years ago

The ID is the groups numerical ID: 107714

@deniak is that correct?

gkellogg commented 4 years ago

Relevant (closed) ReSpec issue: https://github.com/w3c/respec/issues/1443

deniak commented 4 years ago

The ID is the groups numerical ID: 107714

@deniak is that correct?

Correct. You can find all the rules with examples of markups at https://www.w3.org/pubrules/doc/rules/?profile=WG-NOTE

gkellogg commented 4 years ago

But, it seems that ReSpec should be doing this, which it's not, at least in 25.6.2.

deniak commented 4 years ago

Can you point me to the respec document?

gkellogg commented 4 years ago

https://github.com/w3c/json-ld-streaming/index.html.

Or, run through specgen

gkellogg commented 4 years ago

It may depend on an (undocumented) configuration variable wgId, looking at the source, I'll give that a try.

gkellogg commented 4 years ago

Yes, adding a wgId configuration variable seems to create it. I'll make sure the ReSpec Wiki documents this.

deniak commented 4 years ago

I'm not a respec expert but it may also rely on wgPatentURI: https://github.com/w3c/respec/wiki/wgPatentURI

deniak commented 4 years ago

Yes, looking at https://github.com/w3c/respec/blob/develop/src/w3c/headers.js#L447 it's either wgIdor wgPatentURI so 👍 to document wgIdas well

gkellogg commented 4 years ago

Document had a wgPatentURI, but it didn't seem to take it from there.

gkellogg commented 4 years ago

Still seeing an error "Required patent policy paragraph not found.", even though it's in the document.

Also, there is a discrepancy in expectations on "FPWG-NOTE" vs "FPWD-NOTE", which I noted in w3c/respec#2852. I don't know if this would explain the error.

Link checker is back up, and links check out in the document.

gkellogg commented 4 years ago

@iherman I presume that, because this is a First Public note (FPWG-NOTE, depending on if ReSpec's FPWD-NOTE works okay), we'll need a snapshot created in the repo for publishing? What publication date shall we use?

iherman commented 4 years ago

@gkellogg we have to wait until the PR date is set. Yes, FPWD-NOTE should be fine.