Repository navigation
node@0.10 -> iojs@1.0.0 changelog #339
Description
Activity
prematurely pressed submit somehow, updated description after initial issue creation ^
and to clarify timing: we need this for 1.0.0, so preferably within the next hour or two!
There is already work being done at https://code.stypi.com/domenic/iojs-1.0-changelog.md
If someone could figure out a shell script or GitHub URL or something that does a rich (rendered) diff of the markdown docs from Node 0.10.35 to io.js 1.0.0, I think that would help immensely.
This script seems to do the trick:
#!/usr/bin/env bash curl https://raw.githubusercontent.com/iojs/io.js/v1.x/doc/api/$1.markdown > $1.iojs.markdown curl https://raw.githubusercontent.com/joyent/node/v0.10.35/doc/api/$1.markdown > $1.node.markdown wdiff $1.node.markdown $1.iojs.markdown | sh ./markdown-format-wdiff.sh > $1.changes.markdown greadme $1.changes.markdown
using https://raw.githubusercontent.com/netj/markdown-diff/master/markdown-format-wdiff for markdown-format-wdiff.sh
OK, I went through diffs of all the docs and filled in anything that was missing. The stypi is pretty up-to-date. I pasted a snapshot into https://gist.github.com/domenic/ed1bd3628748000acfe5 just in case someone accidentally deletes the whole thing.
I left a "still to-do" section at the top which contains the following:
- Fill out TLS section
- Fill out cluster section
- Better explanation for HTTP keep-alive changes?
- Fix links to docs once there are actual docs on the io.js web site. Probably add more links to docs.
- Flesh out the "General" section a bit more maybe with some flavor text. "IO.js is the result of more than 2 years of work that never saw the light of day over on joyent/node, plus our own goodies, blah blah blah."
- Maybe add discussion of changes in TLS support in the General section.
But otherwise I think we did what we could. Hope it helped! I'm going to go back to my day job now but let me know if there's anything else I can help with here.
@domenic filled the TLS/crypto holes in https://code.stypi.com/domenic/iojs-1.0-changelog.md
@bnoordhuis are you able to take cluster and maybe keep-alive, or is there someone else who feels more qualified to do keep-alive?
I'm afraid I have to sign off in a few minutes. I have to get up early for a funeral tomorrow.
We could always leave those as "(This section of the changelog is still in-progress; check back later)"
TC meeting today decided it would be good to have at least a broad-strokes changes document to show what's different in this release but we have to divide the work.
Need volunteers for each of the following sections (not limited to TC, anyone knowledgeable in the area can do it), please post a comment and say which module you're doing, then when you're done post a link to wherever you've prepared your document and I'll aggregate it into a single format. Please use Markdown:
also a section on major V8 changes would be good, that could be split up to:
Writing should be concise and user-facing, not a bunch of commit log entries. What should people expect when they try this new beast out? What to look for, what they'll need to take into account when adapting their code, what new features to experiment with.