Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
domenic opened this issue Aug 31, 2015 · 21 comments
Closed

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

domenic opened this issue Aug 31, 2015 · 21 comments

Comments

@domenic
Copy link
Collaborator

domenic commented Aug 31, 2015

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
Copy link
Owner

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.

  • Update the suite to run against the latest single page edition
  • Publish it to gh-pages
  • Point DNS at github (@Hixie)
  • Update design, modernise front-end
  • Investigate more modern tooling (python spec-splitter update, remove janky ruby, etc) OR, make moves to make the role of this repository to style and deploy the specification (rather than the insane processing etc that it does now).

@domenic
Copy link
Collaborator Author

domenic commented Aug 31, 2015

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
Copy link
Owner

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
Copy link

Hixie commented Aug 31, 2015

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
Copy link
Owner

@Hixie, let's run with that

domenic added a commit to whatwg/html that referenced this issue Sep 2, 2015
- Remove developer version for now, pending benschwarz/developers.whatwg.org#104
- Add "Contribute on GitHub"
- Change "Change Log" from html5.org tracker to GitHub "Commit Log"
- Rename "View Open Bugs" to "Legacy Open Bugs"
- Add "Open Issues" linking to GitHub issues
- Rename "File a Bug" to "Open an Issue"

Fixes #5.
@annevk
Copy link

annevk commented Sep 3, 2015

@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
Copy link
Owner

@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
Copy link

annevk commented Sep 3, 2015

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
Copy link
Owner

@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
Copy link

annevk commented Sep 3, 2015

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
Copy link

annevk commented Sep 3, 2015

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
Copy link

Hixie commented Sep 3, 2015

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
Copy link

annevk commented Sep 4, 2015

@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 added a commit to whatwg/html that referenced this issue Sep 4, 2015
- Remove developer version for now, pending benschwarz/developers.whatwg.org#104
- Add "Contribute on GitHub"
- Change "Change Log" from html5.org tracker to GitHub "Commits"
- Rename "View Open Bugs" to "Legacy Open Bugs"
- Add "Open Issues" linking to GitHub issues
- Rename "File a Bug" to "Open an Issue"

Fixes #5.
@annevk
Copy link

annevk commented Dec 16, 2015

@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
Copy link
Contributor

foolip commented Feb 7, 2016

What's the status of this? In whatwg/html#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
Copy link

annevk commented Feb 8, 2016

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

@CaseyLeask
Copy link
Collaborator

@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
Copy link
Contributor

foolip commented Feb 8, 2016

@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
Copy link
Collaborator Author

domenic commented Mar 1, 2016

Now that #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
Copy link
Collaborator Author

domenic commented Jun 22, 2017

We've finalized on an approach that integrates directly into the HTML build pipeline over in whatwg/html@28b739e, 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
Copy link
Owner

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

alice pushed a commit to alice/html that referenced this issue Jan 8, 2019
This new dev edition is meant to supercede
https://developers.whatwg.org/. It is located at
https://html.spec.whatwg.org/dev/. Closes
benschwarz/developers.whatwg.org#104.

This introduces a developers stylesheet derived from
https://github.com/benschwarz/developers.whatwg.org/tree/97ff943a8f5b8fe38f78e224b4b44b472ccefb57/sass,
including the web fonts. We host the web fonts in this repository,
instead of using Google Fonts, as Google Fonts is blocked in China.
Further help on improving the design of the dev edition going forward is
appreciated; for now we have done a straight port.

It also updates the source document significantly to make the generated
output work better for the dev edition. Special care was given to the
web workers section, and to ensuring that every element definition
references which interface it corresponds to. Further work on properly
marking up the source document is tracked in whatwg#1488.

This new version is missing several features from the old one. In rough
order of importance:

* Search
* Working offline
* "About this specification" introduction on the index page
* Nice footer and header navigation UI on each non-index page
* A distinct favicon

We plan to add most of these back over time.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants