Move the FAQ here #36
Conversation
|
Like with some Bikeshed conversions, I compared the textual before/after and IDs using various scripts, so I'm pretty confident I didn't mess anything up badly. |
|
Pushed another change so that there are two commits now. They shouldn't be squashed when merging, use rebase. |
There was a problem hiding this comment.
This seems like a good first step. I guess I won't review in depth given that you have tools to check the output and you aren't changing anything on the initial import. Although I would omit the HTML stuff ("HTML", "HTML syntax issues", "HTML feature proposals", "WHATWG and the W3C HTML WG", "Using HTML") even from the initial import.
I think there will be real value when we start updating this, especially given overlap with /working-mode.
I'm worried about the /faq redirect and wonder what others think there.
| @@ -84,7 +84,6 @@ redirect permanent /x https://xhr.spec.whatwg.org/ | |||
| redirect permanent /xhr https://xhr.spec.whatwg.org/ | |||
|
|
|||
| redirect permanent /newbug https://github.com/whatwg/html/issues/new | |||
| redirect permanent /faq https://wiki.whatwg.org/wiki/FAQ | |||
There was a problem hiding this comment.
Uh oh. Given cached redirects, we may need a new URL...
There was a problem hiding this comment.
User agents tend not to cache them long so I think we should be fine. We could go with frequently-asked-questions though if we wanted to. Would be consistent with code-of-conduct and working-mode.
There was a problem hiding this comment.
I was hoping that /faq it was rarely linked, but https://html.spec.whatwg.org/ does. But, I'd still like to use the shorter URL, any breakage will be transient.
There was a problem hiding this comment.
Shorter URL is nice. If you all aren't worried then I guess I am not either.
|
Other thoughts: we may want to add self-links, like we did in working-mode. And we may want to mint new IDs, as following this wiki-generated convention for future edits is going to be painful. |
From https://wiki.whatwg.org/wiki/FAQ Initial markdown produced using the already sanitized HTML from whatwg/whatwg.org#36 and https://domchristie.github.io/to-markdown/ to convert it to GitHub-flavored Markdown.
|
I'm going to remove the mailing list part of this as well, instructions for Outlook aren't that helpful. I'll leave it on the wiki when updating it to point to the new FAQs. |
From https://wiki.whatwg.org/wiki/FAQ Initial markdown produced using the already sanitized HTML from whatwg/whatwg.org#36 and https://domchristie.github.io/to-markdown/ to convert it to GitHub-flavored Markdown.
|
This is now ready for review again, I've minted new IDs and done some more cleanup. Still no real changes to the actual content of course. |
There was a problem hiding this comment.
All changes LGTM. Thanks especially for doing the id/self-link work. Happy to merge when you think it's ready, although we might indeed want to get a nice commit history like:
- Move the FAQ here
- Fix broken/redirecting/absolute links in the FAQ
- Drop some FAQ sections
- Improve IDs and styling of FAQ
which would involve some Git surgery. (Or maybe just two commits, one for moving and one for everything else.)
|
I enjoy Git surgery, will try to turn it into something nicer and merge tomorrow. |
This was produced starting from the HTML output of https://wiki.whatwg.org/wiki/FAQ and cleaning it up to match the style of /working-mode and /code-of-conduct. New IDs were minted, but no changes to the text content was made, verified using https://github.com/foolip/epubbase/blob/master/worddiff.py. Some minimal amount of style is carried over or invented to make it not much worse than the old FAQ.
* Use “quotes” and ’s (like /working-mode) * Remove Code of Conduct question, it's linked from the top of the page * Remove broken showModalDialog() link. * Remove bold and italics where it seems out of place.
|
OK, I went with two commits, because once the HTML parts were out of the FAQ, the resulting second commit wasn't too big. |
From https://wiki.whatwg.org/wiki/FAQ Initial markdown produced using the already sanitized HTML from whatwg/whatwg.org#36 and https://domchristie.github.io/to-markdown/ to convert it to GitHub-flavored Markdown.
This was produced starting from the HTML output of
https://wiki.whatwg.org/wiki/FAQ and cleaning it up to match the style
of /working-mode and /code-of-conduct. Only very minor visible changes
were made around whitespace, quotes and similar. Actual changes to the
FAQ will be made separately.
Some minimal amount of style is carried over or invented to make it not
much worse than the old FAQ.
All IDs are preserved.