Skip to content

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

Description

@ChALkeR

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

Activity

  1. added
    bufferIssues and PRs related to the buffer subsystem.
    docIssues and PRs related to Node.js documentation.
    tsc-agendaIssues and PRs to discuss during Technical Steering Committee meetings.
    on Apr 5, 2018
  2. mcollina commented on Apr 5, 2018

    @mcollina
    SponsorMember

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

  3. Trott commented on Apr 11, 2018

    @Trott
    Member

    /ping @nodejs/tsc

  4. Trott commented on Apr 23, 2018

    @Trott
    Member

    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

  5. Trott commented on Apr 23, 2018

    @Trott
    Member

    @nodejs/buffer

  6. fhinkel commented on May 23, 2018

    @fhinkel
    Contributor

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

  7. Trott commented on May 26, 2018

    @Trott
    Member

    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.)

  8. fhinkel commented on May 29, 2018

    @fhinkel
    Contributor

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

  9. ghost added a commit that references this issue on May 30, 2018
  10. BridgeAR commented on May 31, 2018

    @BridgeAR
    Member

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

  11. fhinkel commented on May 31, 2018

    @fhinkel
    Contributor

    Closed.

  12. fhinkel commented on Jun 3, 2018

    @fhinkel
    Contributor
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bufferIssues and PRs related to the buffer subsystem.docIssues and PRs related to Node.js documentation.tsc-agendaIssues and PRs to discuss during Technical Steering Committee meetings.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions