You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
they add interesting & useful features
they change behaviour in a way that's not breaking but may be unexpected (e.g. lower memory usage for TLS)
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.
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.
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:
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:
https://github.com/nodejs/node/issues?utf8=%E2%9C%93&q=is%3Aclosed+label%3Asemver-minor
If you start working on any of this, please keep us informed in this thread so we don't end up overlapping work.
The text was updated successfully, but these errors were encountered: