benschwarz / developers.whatwg.org

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

How can we keep this updated with the latest HTML Standard? #104

Closed domenic closed 7 years ago

domenic commented 9 years ago

Hey @benschwarz,

As you may know we moved the HTML Standard to GitHub at https://github.com/whatwg/html. We'd love to keep developers.whatwg.org in sync with the spec more readily, and are happy to help in any way possible. According to @Hixie, the build process can spit out something vaguely developer-like, but support is incomplete. (It uses the w-nodev annotations in the source.)

What can we do to get developers.whatwg.org updated?

Alternately, if you think it's not going to be possible for a while, maybe we should add an "outdated" notice?

benschwarz commented 9 years ago

Hi!

if you think it's not going to be possible for a while, maybe we should add an "outdated" notice?

I've been thinking about this for a while now. I really hate that the spec is out of date, and while I'm not a regular user of it myself, I know that many others enjoy using it still — I'd love to see it kept up to date!

I'm not familiar with w-nodev, and I'm kind of unsure how far behind my knowledge is of how everything hangs together, and to be perfectly honest, the post-processing that this repo does is… creative… at best.

To get things moving, we need a full single page specification (I guess https://html.spec.whatwg.org will be the target?), and a bit of nudging to get the suite running with it.

There has been a call to change the tooling to node/js based tooling (#90), but I think that the priority should be set on shipping an update specification.

domenic commented 9 years ago

OK, sounds good! Anything for us to do on that list? https://html.spec.whatwg.org is indeed the latest full single-page version.

benschwarz commented 9 years ago

It needs to be prioritised… but I'm sure I can find a couple of hours somewhere to see where we're at here.

Hixie commented 9 years ago

Wattsi outputs a full-page version that's a better starting point for this than the full spec itself. I think the build script just ignores it currently, but we could expose that for sure.

benschwarz commented 9 years ago

@hixie, let's run with that

annevk commented 9 years ago

@benschwarz would it be ideal if we just generated a zip and pinged a URL on developers.whatwg.org that would collect the new version?

benschwarz commented 9 years ago

@annevk Definitely agree on the /ping and build. The only asset required should be the single HTML, so given that we're using GZIP for the transport… zip is just an unnecessary overhead.

annevk commented 9 years ago

I see. Currently we're also generating a multipage-dev version as far as I can tell. Perhaps we should stop doing that then...

benschwarz commented 9 years ago

@annevk The multipage edition has TOC's throughout etc? Perhaps we should use that one? Then we could remove the whole spec splitter (in theory), and just minimally process the multipage dev.

annevk commented 9 years ago

Correct, it has all that stuff. It's essentially the same multipage is published now, except without the text you don't want.

We should probably also add some review guidelines to whatwg/html's TEAM.md to ensure the appropriate text gets omitted from the developer version. Not sure we've been doing a good job of that.

annevk commented 9 years ago

https://html5.org/temp/multipage-dev.zip hosts a copy of somewhat recent output. As far as I can tell we don't actually generate a developer single-page copy so this might be our only hope at this point unless I'm missing something.

Hixie commented 9 years ago

Yeah I turned off the single-page dev version since d.w.o only has multipage. Sorry, I was confused in my earlier comment here.

annevk commented 9 years ago

@benschwarz if something like the above zip works for you, @domenic and I will make sure we put that online somewhere and then ping your server (what URL? share via email?).

annevk commented 8 years ago

@benschwarz any thoughts? We'd like this version of the HTML Standard to stay maintained. If you don't have time for it would it be okay with you if someone else took over?

foolip commented 8 years ago

What's the status of this? In https://github.com/whatwg/html/issues/626 the option of translating this variant of the spec has come up, but IMHO we really need developer.whatwg.org to be a fully supported and automatically updated first.

annevk commented 8 years ago

@foolip see #107. It seems @CaseyLeask is trying to get this to work.

CaseyLeask commented 8 years ago

@foolip @annevk I'm getting there. Sorry it's taken so much time :-/ I'm currently using https://html5.org/temp/multipage-dev.zip for the updated version, which removes spec-splitter.py and all the processing that it did.

foolip commented 8 years ago

@CaseyLeask No worries, with all of the tooling changes I imagine it's a lot of work to get back in sync. Will follow along in #107.

domenic commented 8 years ago

Now that https://github.com/benschwarz/developers.whatwg.org/pull/107 is merged, what is needed here? @CaseyLeask is it time for us to hook up something that automatically pushes your scripts the multipage-dev.zip, instead of hosting a one-time snapshot at the temp html5.org URL?

domenic commented 7 years ago

We've finalized on an approach that integrates directly into the HTML build pipeline over in https://github.com/whatwg/html/commit/28b739e2d4b1a5b71d0a90c1dad7ff1a99bd7288, with the results live at https://html.spec.whatwg.org/dev/.

@benschwarz, with your permission, I'd like to start the process of moving the work in this repository over to whatwg/html. That would concretely mean:

benschwarz commented 7 years ago

@domenic Amazing! This all sounds good to me. Thanks so much for all your efforts on this.