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

Document 0.10 & 0.12 to LTS changes for migration #34

Closed
rvagg opened this issue Aug 17, 2015 · 3 comments
Closed

Document 0.10 & 0.12 to LTS changes for migration #34

rvagg opened this issue Aug 17, 2015 · 3 comments

Comments

@rvagg
Copy link
Member

rvagg commented Aug 17, 2015

To ease the pain for users switching from 0.10 and 0.12 to LTS we need to provide better documentation, currently we have very little.

There's two main areas:

  • Breaking changes: listed as things you must pay attention to in your applications because stuff will break.
  • Additions that are not necessarily breaking but are interesting because:
    1. they add interesting & useful features
    2. they change behaviour in a way that's not breaking but may be unexpected (e.g. lower memory usage for TLS)
    3. they present a potential risk for breaking existing usage—the fact is that we can't test every workflow & use-case of Node so we honestly can't say that any change won't be breaking for some user, this is where this list is most helpful to large users who are risk averse; if we give them insight to the areas that have changed they at least know where to look.

C++ API changes are another part of this but obviously. Can be fleshed out with NAN 2 docs if necessary

Dot-points with links to pull requests would be enough to get started. Probably also worth doing this in the LTS wiki.

Some of the existing resources:

If you start working on any of this, please keep us informed in this thread so we don't end up overlapping work.

@rvagg
Copy link
Member Author

rvagg commented Sep 22, 2015

I've done a partial merge of the nodejs/node-v0.x-archive wiki and the nodejs/node wiki (via git) and so far just moved the API/migration guides and also left placeholders on the nodejs/node-v0.x-archive wiki pointing to their new location so we don't have duplicates.

There is now a placeholder doc for v0.10 -> v4 @ https://github.com/nodejs/node/wiki/API-changes-between-v0.10-and-v4 and @Fishrock123 has a ton of content he's been preparing for this that he'll drop very shortly.

/cc @evanlucas cause I noticed you were editing that doc, perhaps hold off on major work until @Fishrock123's changes have landed

@evanlucas
Copy link

Ah thanks for the heads up. Sorry, saw you had created the page and was trying to help out :]

I'll take a look after he gets the changes in.

@Fishrock123
Copy link
Contributor

I dumped my content into there. This can probably be closed?

@rvagg rvagg closed this as completed Sep 22, 2015
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

3 participants