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

io.js (IO.js? iojs?) and node.js documentation fragmentation #135

Closed
zeusdeux opened this issue Dec 10, 2014 · 4 comments
Closed

io.js (IO.js? iojs?) and node.js documentation fragmentation #135

zeusdeux opened this issue Dec 10, 2014 · 4 comments

Comments

@zeusdeux
Copy link
Contributor

In a scenario where in some application, sub system A is dependent on say node 0.10.33 and another sub-system B is dependent on io.js 1.0.0-alpha1, where will the documentation reside?

Will it be fragmented (hosted by both nodejs.org and iojs.org)?
Would the devs be able to treat the io.js documentation as a superset of the documentation hosted at nodejs.org and just refer to that?
Will JNAB make a decision on this?
Does it even matter? (imho I think it does.)

I personally think it would suck for new devs coming on board if they would have to consult different docs that might be possibly conflicting.

@bnoordhuis
Copy link
Member

In a scenario where in some application, sub system A is dependent on say node 0.10.33 and another sub-system B is dependent on io.js 1.0.0-alpha1, where will the documentation reside?

I'm not sure what you mean with 'sub system' here but documentation for io.js will be hosted on http://iojs.org/ and documentation for joyent/node at the regular place.

Will JNAB make a decision on this?

The JNAB has no authority over io.js so no.

I personally think it would suck for new devs coming on board if they would have to consult different docs that might be possibly conflicting.

The goal is to remain as compatible with joyent/node as is reasonably possible, just release more frequently and add features at a quicker pace.

@zeusdeux
Copy link
Contributor Author

I'm not sure what you mean with 'sub system' here but documentation for io.js will be hosted on http://iojs.org/ and documentation for joyent/node at the regular place.

What I meant by a sub system was, for example, a system that streams logs to some destination as a part of a bigger application. Two separate locations for docs then, cool.

The goal is to remain as compatible with joyent/node as is reasonably possible, just release more frequently and add features at a quicker pace.

Right, cool. I just hope we don't end up with differences in docs for, for example, streams in joyent/node and io.js. :)

Thanks @bnoordhuis.

@rvagg
Copy link
Member

rvagg commented Dec 11, 2014

@zeusdeux do you need any other information here or can the issue be closed?

@zeusdeux
Copy link
Contributor Author

@rvagg This shall do for now. Closing.

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