bikeshed: Unknown Status 'ED' used ?!@#$

Discussion:

Hodges, Jeff

2016-08-17 22:49:34 UTC

somewhat all of a sudden, the cloud-hosted bikeshed claims: Unknown
Status 'ED' used

here's the details..

output=err > errors.txt ; ls -l errors*

% Total % Received % Xferd Average Speed Time Time Time
Current
Dload Upload Total Spent Left
Speed
100 116k 0 162 100 116k 222 160k --:--:-- --:--:-- --:--:--
160k
-rw-r--r-- 1 jehodges 110028724 162 Aug 17 15:22 errors.txt

cat errors.txt

Error running preprocessor, returned code: 1.
\033[1;31mFATAL ERROR:\033[0m Unknown Status 'ED' used.
\033[7;31m ✘ \033[0m Did not generate, due to fatal errors

The metadata section in this index.bs begins with..

<pre class='metadata'>
Title: Web Authentication: An API for accessing Scoped Credentials
Status: ED
TR: http://www.w3.org/TR/webauthn/
ED: http://w3c.github.io/webauthn/
Shortname: webauthn
...
</pre>

This is a bug, yes? 'ED' is used as a value for Status in the example on..

https://github.com/tabatkins/bikeshed/blob/master/docs/metadata.md

That page also says that documenting the allowed values for Status is a
"TODO" -- what's the status of that?

I also note that playing around with the leading whitespace of the lines
within the <pre class='metadata'> section yields different error msgs,
sigh.

was the bikeshed impl behind https://api.csswg.org/bikeshed/ recently
updated? I wasn't having this issue with this index.bs file back in June.

thanks,

=JeffH

Tab Atkins Jr.

2016-08-18 00:10:03 UTC

Permalink

Post by Hodges, Jeff
somewhat all of a sudden, the cloud-hosted bikeshed claims: Unknown
Status 'ED' used
here's the details..

output=err > errors.txt ; ls -l errors*

cat errors.txt

Kinda sorta, but mostly WAI. I've begun namespacing the statuses
based on "supergroup" - W3C groups have access to the W3C document
statuses, ISO groups have access to the ISO statuses, etc. This
avoids collisions between independent groups.

Unfortunately, I haven't yet added a good way to let Bikeshed know
that you're a W3C group, besides me adding your group to the list
manually. Happy to do so - what's your Group?

Post by Hodges, Jeff
'ED' is used as a value for Status in the example on..
https://github.com/tabatkins/bikeshed/blob/master/docs/metadata.md
That page also says that documenting the allowed values for Status is a
"TODO" -- what's the status of that?

Still TODO, because the list is long and I need to rejigger how I do
my documentation.

Post by Hodges, Jeff
I also note that playing around with the leading whitespace of the lines
within the <pre class='metadata'> section yields different error msgs,
sigh.

Yes, metadata can't have leading whitespace. If you do so, it triggers
the "continuation line" feature, where you can spread a multi-line
value over multiple lines without having to repeat the metadata name
again.

This isn't explained well - thanks for pointing out the documentation bug!

Post by Hodges, Jeff
was the bikeshed impl behind https://api.csswg.org/bikeshed/ recently
updated? I wasn't having this issue with this index.bs file back in June.

Yes, it updates within a few minutes of me pushing changes to the
repository. This change definitely occurred more recently than June.

~TJ

Hodges, Jeff

2016-08-18 00:31:38 UTC

Permalink

thanks for speedy reply Tab...

Post by Tab Atkins Jr.

Post by Hodges, Jeff
somewhat all of a sudden, the cloud-hosted bikeshed claims: Unknown
Status 'ED' used
here's the details..

output=err > errors.txt ; ls -l errors*

cat errors.txt

Kinda sorta, but mostly WAI.

WAI?

Post by Tab Atkins Jr.
I've begun namespacing the statuses
based on "supergroup" - W3C groups have access to the W3C document
statuses, ISO groups have access to the ISO statuses, etc. This
avoids collisions between independent groups.

by "supergroup" you essentially mean "standards development org (SDO)" ?

Post by Tab Atkins Jr.
Unfortunately, I haven't yet added a good way to let Bikeshed know
that you're a W3C group, besides me adding your group to the list
manually. Happy to do so - what's your Group?

ah, if you are referring to the metadata "group", and by implication, the
W3C working group, it is "webauthn" (short name) "web authentication"
(long name).

perhaps you could automate syncing the present active w3c groups from e.g.
https://www.w3.org/Consortium/activities ?

Post by Tab Atkins Jr.

Still TODO, because the list is long and I need to rejigger how I do
my documentation.

might you just be able to let us know what the allowed values for "status"
is for a W3C group?

Post by Tab Atkins Jr.

Post by Hodges, Jeff
I also note that playing around with the leading whitespace of the lines
within the <pre class='metadata'> section yields different error msgs,
sigh.

although, I have experienced fatal errors if the first metadata line,
which for us is "title", is not indented at least one space.

Post by Tab Atkins Jr.
This isn't explained well - thanks for pointing out the documentation bug!

you're welcome -- yeah, i've run across various frustrating issues with
whitespace significance in bikeshed, mostly in the metadata block, but i
was using various bikeshed versions and so haven't kept track of 'em.

Post by Tab Atkins Jr.

Post by Hodges, Jeff
was the bikeshed impl behind https://api.csswg.org/bikeshed/ recently
updated? I wasn't having this issue with this index.bs file back in June.

Yes, it updates within a few minutes of me pushing changes to the
repository. This change definitely occurred more recently than June.

so https://api.csswg.org/bikeshed/ is bleeding edge? do you publish
release notes when you so push? unfortunately I haven't been able to get
bikeshed updated locally and so am personally relying on that cloud
version.

Hodges, Jeff

2016-08-18 16:56:15 UTC

Permalink

On 8/17/16, 5:31 PM, "Hodges, Jeff" <***@paypal.com<mailto:***@paypal.com>> wrote:

Unfortunately, I haven't yet added a good way to let Bikeshed know
that you're a W3C group, besides me adding your group to the list
manually. Happy to do so - what's your Group?

ah, if you are referring to the metadata "group", and by implication, the
W3C working group, it is "webauthn" (short name) "web authentication"
(long name).

is it possible to get our group name added to your group-name-list in the near future? I'm still unable to process our spec via https://api.csswg.org/bikeshed/ , plus if someone updates the bikeshed rev our travisCI integration uses, it'll break auto our auto-spec-rendering IIUC...

thx

=JeffH

Hodges, Jeff

2016-08-22 00:12:51 UTC

Permalink

Tab fixed this last Friday -- Thx!

###
On 8/18/16, 9:56 AM, "Hodges, Jeff" <***@paypal.com<mailto:***@paypal.com>> wrote:

On 8/17/16, 5:31 PM, "Hodges, Jeff" <***@paypal.com<mailto:***@paypal.com>> wrote:

Unfortunately, I haven't yet added a good way to let Bikeshed know
that you're a W3C group, besides me adding your group to the list
manually. Happy to do so - what's your Group?

ah, if you are referring to the metadata "group", and by implication, the
W3C working group, it is "webauthn" (short name) "web authentication"
(long name).

is it possible to get our group name added to your group-name-list in the near future? I'm still unable to process our spec via https://api.csswg.org/bikeshed/ , plus if someone updates the bikeshed rev our travisCI integration uses, it'll break auto our auto-spec-rendering IIUC...

thx

=JeffH

Tab Atkins Jr.

2016-08-19 18:50:50 UTC

Permalink

Post by Hodges, Jeff
WAI?

Working As Intended.

Post by Hodges, Jeff

by "supergroup" you essentially mean "standards development org (SDO)" ?

Yeah.

Post by Hodges, Jeff
might you just be able to let us know what the allowed values for "status"
is for a W3C group?

It's all the W3C status shortnames - ED, WD, CR, etc.

Post by Hodges, Jeff
although, I have experienced fatal errors if the first metadata line,
which for us is "title", is not indented at least one space.

That's... extremely weird and not experience by literally anyone else
as far as I know? I'd love to see a file where this problem occurred.

Post by Hodges, Jeff
so https://api.csswg.org/bikeshed/ is bleeding edge?

Yes.

Post by Hodges, Jeff
do you publish
release notes when you so push?

No. At some point I should probably do so, but Bikeshed's still in
the "just fix bugs as they show up" stage.

Post by Hodges, Jeff
unfortunately I haven't been able to get
bikeshed updated locally and so am personally relying on that cloud
version...

That's why we run it. ^_^

~TJ

Hodges, Jeff

2016-08-22 00:17:48 UTC

Permalink

On 8/19/16, 11:50 AM, "Tab Atkins Jr." <***@gmail.com<mailto:***@gmail.com>> wrote:
On Wed, Aug 17, 2016 at 5:31 PM, Hodges, Jeff <***@paypal.com<mailto:***@paypal.com>> wrote:
WAI?

Working As Intended.

doh.

although, I have experienced fatal errors if the first metadata line,
which for us is "title", is not indented at least one space.

That's... extremely weird and not experience by literally anyone else
as far as I know? I'd love to see a file where this problem occurred.

well, the input file was some earlier version of https://github.com/w3c/webauthn/blob/master/index.bs (it was named index.src.html at the time) but could perhaps be re-created with the current version, though I can't recreate it cuz my local copy of bikeshed is horked, and https://api.csswg.org/bikeshed/ appears to not have the issue... sorry,

=JeffH

Tab Atkins Jr.

2016-09-02 23:24:16 UTC

Permalink

Post by Tab Atkins Jr.

Post by Hodges, Jeff
somewhat all of a sudden, the cloud-hosted bikeshed claims: Unknown
Status 'ED' used
here's the details..

output=err > errors.txt ; ls -l errors*

cat errors.txt

Kinda sorta, but mostly WAI. I've begun namespacing the statuses
based on "supergroup" - W3C groups have access to the W3C document
statuses, ISO groups have access to the ISO statuses, etc. This
avoids collisions between independent groups.
Unfortunately, I haven't yet added a good way to let Bikeshed know
that you're a W3C group, besides me adding your group to the list
manually. Happy to do so - what's your Group?

All of this is thoroughly fixed now! First, Bikeshed emits a useful
error message actually telling you what's wrong, and suggests a fix.
Second, it now allows you to tell it that you're a W3C group, even if
your group isn't on Bikeshed's list yet. Third, the docs now list all
the statuses (didn't realize you were allowed to use <details> in
GitHub Markdown; that's what I was waiting for).

~TJ

Hodges, Jeff

2016-11-07 23:13:45 UTC

Permalink

Post by Tab Atkins Jr.

Post by Hodges, Jeff
somewhat all of a sudden, the cloud-hosted bikeshed claims: Unknown
Status 'ED' used
here's the details..

output=err > errors.txt ; ls -l errors*

cat errors.txt

Kinda sorta, but mostly WAI. I've begun namespacing the statuses
based on "supergroup" - W3C groups have access to the W3C document
statuses, ISO groups have access to the ISO statuses, etc. This
avoids collisions between independent groups.
Unfortunately, I haven't yet added a good way to let Bikeshed know
that you're a W3C group, besides me adding your group to the list
manually. Happy to do so - what's your Group?

All of this is thoroughly fixed now! First, Bikeshed emits a useful
error message actually telling you what's wrong, and suggests a fix.

yay! thx :)

Post by Tab Atkins Jr.
Second, it now allows you to tell it that you're a W3C group, even if
your group isn't on Bikeshed's list yet. Third, the docs now list all
the statuses (didn't realize you were allowed to use <details> in
GitHub Markdown; that's what I was waiting for).

interesting -- so is the documentation at
https://tabatkins.github.io/bikeshed/ new? my cached tabs to the old .md
files all now 404, so I guess so..

=JeffH

Tab Atkins Jr.

2016-11-07 23:35:09 UTC

Permalink

Post by Hodges, Jeff
interesting -- so is the documentation at
https://tabatkins.github.io/bikeshed/ new? my cached tabs to the old .md
files all now 404, so I guess so..

Yes, all the docs moved to a single Bikeshed document. Much easier to
search and use now!

~TJ