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

doc: add documentation on porting from Buffer(arg) usage #19827

Closed
ChALkeR opened this issue Apr 5, 2018 · 11 comments
Closed

doc: add documentation on porting from Buffer(arg) usage #19827

ChALkeR opened this issue Apr 5, 2018 · 11 comments
Labels
buffer Issues and PRs related to the buffer subsystem. doc Issues and PRs related to the documentations. tsc-agenda Issues and PRs to discuss during the meetings of the TSC.

Comments

@ChALkeR
Copy link
Member

ChALkeR commented Apr 5, 2018

Refs: #19079

As previously discussed, it would be great if we could provide that instructions somewhere (docs, news, medium, whatever).

I made an initial draft in my repo here: Porting-Buffer.md, and @addaleax contributed significant parts of it.

What would be the next steps to discuss it and fix it so that it could be included somewhere?
I guess that needs to be done in time for 10.0 release.

Also: comments/patches to the doc at its current state are welcomed.

/cc @nodejs/tsc

@ChALkeR ChALkeR added buffer Issues and PRs related to the buffer subsystem. doc Issues and PRs related to the documentations. tsc-agenda Issues and PRs to discuss during the meetings of the TSC. labels Apr 5, 2018
@mcollina
Copy link
Member

mcollina commented Apr 5, 2018

I think the best place is a medium blog post or a guide https://nodejs.org/en/docs/guides. Or both.

@ghost
Copy link

ghost commented Apr 5, 2018

The deprecation of the Buffer constructor was documented here: https://github.com/nodejs/node/wiki/Breaking-changes-between-v5-and-v6.
The node docs also mark those methods are deprecated.
I went through that process for a code base and I think this was well documented.

@Trott
Copy link
Member

Trott commented Apr 11, 2018

/ping @nodejs/tsc

@Trott
Copy link
Member

Trott commented Apr 23, 2018

This is on the TSC agenda for this week, but it's not clear to me what the TSC needs to actually decide. Can we get a brief explanation of what is needed from the TSC on this? @ChALkeR

@Trott
Copy link
Member

Trott commented Apr 23, 2018

@nodejs/buffer

@fhinkel
Copy link
Member

fhinkel commented May 23, 2018

ping @ChALkeR Is there anything we need to discuss? Or is it just FYI on the tsc agenda?

@Trott
Copy link
Member

Trott commented May 26, 2018

I created a pull request with some improvements, but nothing that changes the actual meaning of any text significantly. ChALkeR/safer-buffer#5

@fhinkel In the TSC meeting, we agreed to give this doc editing until today and then hand it off to...you, was it? I obviously did not get to go over this as thoroughly as I had hoped, but if someone else has more time and/or energy, great! If we can publish it somewhere that others can continue to edit and improve it, then I think it's ship-able. (I'm almost sorry that we don't have the nodejs repo wiki anymore.)

@fhinkel
Copy link
Member

fhinkel commented May 29, 2018

Thanks @Trott, I'm on it right now 😺

@BridgeAR
Copy link
Member

Hey, should this issue actually be closed or stay open? It was just weird that a commit from the wrong repo closed it.

@fhinkel
Copy link
Member

fhinkel commented May 31, 2018

Closed.

@fhinkel fhinkel closed this as completed May 31, 2018
@fhinkel
Copy link
Member

fhinkel commented Jun 3, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
buffer Issues and PRs related to the buffer subsystem. doc Issues and PRs related to the documentations. tsc-agenda Issues and PRs to discuss during the meetings of the TSC.
Projects
None yet
Development

No branches or pull requests

5 participants