search

w3c / wpub

W3C Web Publications
https://w3c.github.io/wpub/
Other
78 stars 19 forks source link

Major changes to WP explainer #393

Closed dauwhe closed 5 years ago

dauwhe commented 5 years ago

I've attempted to rewrite the explainer for a world where we are just defining the manifest, as discussed in Ivan's gist

iherman commented 5 years ago

I like it. However, I do believe that some easy and quick editorial work should be done on the current documents before we contact the TAG. The name of the main document should be changed, the affordances should be parked somewhere, etc. I think these changes can be done quickly (@mattgarrish ?), we can then republish the document within a few days.

Also, depending on when the TAG review is scheduled, the remark on packaging may be updated. If indeed the decision will be to use OCF as a basis of this 'light-weight' packaging, then we should make it clear and also emphasize that this is the format already used by publishers, ie, the machinery to deploy it becomes easy and it is (will be?) well specified as a format.

mattgarrish commented 5 years ago

I think these changes can be done quickly

I got as far as making a branch to work on this yesterday... :)

Changing the name and stripping the affordances is certainly simple, but actually running through the specification and making sure everything makes sense to this new world view might take a little more time. I've got a couple of priorities off my plate now, though, so will see what I can accomplish this afternoon.

iherman commented 5 years ago

I think that for a change/PR of such depth it would be worth leaving it open 1-2 days more and possibly notify the WG by email (as we will not have a meeting for 10 more days).

wareid commented 5 years ago

Changes look good to me, but I think I agree with Ivan we should share. Would there be a way to display the revised version without the diff view for those not fond of reading between lines. Happy to send it out.

iherman commented 5 years ago

@wareid,

https://pr-preview.s3.amazonaws.com/w3c/wpub/pull/394.html

is a URI for the updated WP draft done by @mattgarrish. It is not perfect re styling, but the content is there. So the mail could refer to this and the other PR in one blow.

iherman commented 5 years ago

Oops, sorry @wareid , I forgot about the URI for this PR without diff view:

https://github.com/w3c/wpub/blob/cc98b79356b6080c56421bb66eca792ad3baafda/explainers/wpub-explainer.md (a.k.a. https://tinyurl.com/y7pwnama)

iherman commented 5 years ago

Per mailing list cfc merging and closing.