tr-design icon indicating copy to clipboard operation
tr-design copied to clipboard

Corner case: special "discontinued" spec

Open tripu opened this issue 9 years ago • 6 comments

eg, https://www.w3.org/TR/2016/NOTE-XMLHttpRequest-20161006/. It has no ToC, and the SotD section is the only one.

Per pubrules, we require a ToC, that it includes fixup.js, etc. Those things don't make sense in a case like this one, and cause errors.

What do you think, @fantasai, @plehegar, @deniak?

tripu avatar Oct 06 '16 09:10 tripu

I suggest we leave corner cases like this one out of formal rules and checkers: if a spec is discontinued, let's set up a generic "discontinued" page under /TR that catches those cases; possibly with redirections, or additional customisable info.

Otherwise, the rules we have for “normal” specs won't apply, and we'll have to either relax them in the checkers, make exceptions, or publish manually.

tripu avatar Oct 06 '16 09:10 tripu

Indeed, the TR redesign 2016 introduced the ToC requirement. Since we have a use case where a ToC is completely useless, we could change that requirement into a suggestion instead. Pubrules will not fail if it can't find a ToC.

deniak avatar Oct 06 '16 12:10 deniak

My fear is that if we relax the rules to fit the lowest common denominator we'll end up with only a few rules that won't be very helpful. eg, just because a few weird specs are published without a ToC, we'll now allow every other spec to be published without a ToC? And so on.

tripu avatar Oct 06 '16 14:10 tripu

One possibility is to have an option to desactivate the ToC requirement, which indeed doesn't make sense here. My guess is that this option would only be applicable in the case of discontinued Note.

plehegar avatar Oct 21 '16 21:10 plehegar

(Strong candidate for our next cycle; whether that's some time in 2016 or not.)

tripu avatar Nov 15 '16 18:11 tripu

Most recent discountinued Note: https://www.w3.org/TR/2017/NOTE-tvcontrol-api-20170518/

plehegar avatar May 25 '17 18:05 plehegar