benschwarz / developers.whatwg.org

Used to create the contents of developers.whatwg.org
http://developers.whatwg.org/
198 stars 39 forks source link

[WIP] Update suite to run against the latest #107

Closed CaseyLeask closed 8 years ago

CaseyLeask commented 8 years ago

There's a lot here I'm not clear on, like how to get Wattsi's full-page version. After digging through https://github.com/whatwg/html-build/blob/master/build.sh I have more of an idea how this all sticks together, but there's so many different toolchains it might take some time.

benschwarz commented 8 years ago

We might want to update anolis and spec splitter etc etc? I guess by running make you've already got recent versions?

domenic commented 8 years ago

So HTML doesn't use Anolis anymore. Wattsi is supposed to output a dev multipage version for you; you can see an older snapshot at https://html5.org/temp/multipage-dev.zip, or use Wattsi + build.sh to generate it directly. See more in https://github.com/benschwarz/developers.whatwg.org/issues/104

CaseyLeask commented 8 years ago

Thanks for the fast response folks! Wasn't expecting anything back for a bit.

To borrow from @benschwarz, is this the updated todo list?

CaseyLeask commented 8 years ago

I've reached the point where nothing crashes and it emits a zero error code on make. From this point on, I'll try my best to match the current output at https://developers.whatwg.org/

domenic commented 8 years ago

That sounds about right, although some of the tooling might be obsolete, e.g. the spec comes pre-split. So maybe along the lines of your "OR".

On the other hand, if you get something working with updated content and auto-updating, that'll be a big improvement no matter the strategy :D

benschwarz commented 8 years ago

Sounds good @CaseyLeask — I want to see the spec updated with the latest generated copy, then move to work on improving the tooling / generation / deployment, and then finally start working on the design and functionality of it.

benschwarz commented 8 years ago

Thanks for the hard work so far @CaseyLeask :whale:

CaseyLeask commented 8 years ago

head is looking much better now. Onto the body of the doc.

benschwarz commented 8 years ago

:tada:

annevk commented 8 years ago

@CaseyLeask let us know if you want us to generate something like https://html5.org/temp/multipage-dev.zip automatically and ping your build script somehow. That might be easier than running a fork of the build script and such.

Filing an issue against https://github.com/whatwg/html-build once you're ready for that is probably easiest.

(Thanks @benschwarz for pointing me towards this thread!)

CaseyLeask commented 8 years ago

@annevk That sounds like a good idea. I'm using https://html5.org/temp/multipage-dev.zip in this version.

I think I've still got a long way to go with this one. spec-splitter did a lot more wrangling than I gave it credit for.

annevk commented 8 years ago

Note that we could also change https://github.com/whatwg/wattsi if the output for the developer edition is not great. Wattsi ultimately generates that so if there are things that are not usable we can simply change them.

CaseyLeask commented 8 years ago

I'm keeping track of the issues in the branch, so I can keep a reasonable measure of progress. https://github.com/CaseyLeask/developers.whatwg.org/issues

annevk commented 8 years ago

@CaseyLeask let us know if things would be better to update upstream. Since we already generate a multipage developer copy, tweaking that might be a better solution than post-processing. And ensure things stay synchronized.

benschwarz commented 8 years ago

@annevk, the biggest blocker is the lack of the TOC… a few other details, but that's the big one

annevk commented 8 years ago

The multipage-dev that whatwg/html-build generates and I posted an output copy from at https://html5.org/temp/multipage-dev.zip has both a TOC for all documents in index.html and each individual page also has a TOC at the beginning. I checked just now and this is also true if you generate a new more up-to-date copy from scratch.

benschwarz commented 8 years ago

@annevk Does it align with what's already deployed on developers.whatwg.org?

annevk commented 8 years ago

I think that is definitely the intent, yes. It's basically the HTML standard without the sections marked as being specific to implementers (which we might not always annotate carefully since there's no current output to inspect, but we should fix that in the source document). I don't know how you got there prior to this point, but this seems like a good strategy.

benschwarz commented 8 years ago

@CaseyLeask, I think we should merge what you have, then work on smaller specific issues from there, what's in master doesn't work at all, and this is at least half-way there. We can get it deploying to github pages etc, and start ironing out the kinks.

Good with you?

CaseyLeask commented 8 years ago

@benschwarz Good with me.

domenic commented 8 years ago

Let us know when it's time to start setting up an automated system to deliver the dev version and deliver it to you.