Sitelet https://github.com/nodejs/node/issues/393
Skip to content

Order docs alphabetically #393

Closed
Closed
Order docs alphabetically#393
Labels
docIssues and PRs related to Node.js documentation.good first issueIssues that are suitable for first-time contributors.

Description

@MattMS
MattMS
opened on Jan 14, 2015

Would it be possible to have the docs Markdown files ordered alphabetically to make it easier to use as a reference?

I am happy to do work towards this but I am not familiar enough with the documentation process to know if there would be any side-effects, such as with the JSON output.

Activity

  1. brendanashworth commented on Jan 22, 2015

    @brendanashworth
    brendanashworth
    on Jan 22, 2015
    Contributor

    A little bit trivial, but it doesn't make any sense to have the list in alphabetical order but the all page be in... seemingly random order. I don't think there'd be any side effects to this, @MattMS.

    👍

  2. MattMS commented on Jan 22, 2015

    @MattMS
    MattMS
    on Jan 22, 2015
    Author

    Cool. Well #553 is my first step to see if anyone else is interested.

  3. Fishrock123
    added
    docIssues and PRs related to Node.js documentation.
    on Jan 22, 2015
  4. brendanashworth
    added a commit that references this issue on Jan 23, 2015

    doc: alphabetize all.markdown

    8e87375
  5. Fishrock123
    added
    discussIssues opened for discussion and feedback.
    ideas
    and removed
    ideas
    on Jan 30, 2015

  6. robertkowalski commented on Mar 1, 2015

    @robertkowalski
    robertkowalski
    on Mar 1, 2015
    Contributor

    @MattMS I think this got merged and we can close it, right?

  7. brendanashworth commented on Mar 1, 2015

    @brendanashworth
    brendanashworth
    on Mar 1, 2015
    Contributor

    @robertkowalski the pull request where the change was proposed was closed in favor of waiting how things go forward in joyent/node

  8. MattMS commented on Mar 1, 2015

    @MattMS
    MattMS
    on Mar 1, 2015
    Author

    From #740 it sounds like (the idea of) #553 would be fine now, right?

  9. robertkowalski commented on Mar 1, 2015

    @robertkowalski
    robertkowalski
    on Mar 1, 2015
    Contributor

    @robertkowalski the pull request where the change was proposed was closed in favor of waiting how things go forward in joyent/node

    @MattMS @brendanashworth hmm... I don't see a PR at joyent/node...

    From #740 it sounds like (the idea of) #553 would be fine now, right?

    @MattMS I think you are probably right that as #740 landed docs will be hard to merge anyway. @brendanashworth what do you think?

  10. rvagg commented on Mar 1, 2015

    @rvagg
    rvagg
    on Mar 1, 2015
    Member

    I'm +1 on just pushing ahead with improving docs even if it means making it hard to merge stuff. In reality, there's not a whole lot of docs work going on in joyent/node, most of it is happening here. The improved docs situation here is a benefit to the whole community. node-forward y'all.

  11. tellnes commented on Mar 1, 2015

    @tellnes
    tellnes
    on Mar 1, 2015
    Contributor

    +1 what @rvagg.

    There is already so much changes to the docs anyway, so this will probably only be one of many problems if you wants to merge those branches.

  12. robertkowalski commented on Mar 1, 2015

    @robertkowalski
    robertkowalski
    on Mar 1, 2015
    Contributor

    I am also +1 and would merge tomorrow if no one objects

  13. MattMS commented on Mar 2, 2015

    @MattMS
    MattMS
    on Mar 2, 2015
    Author

    All sounds great to me 😄

    I'm happy to spend some time reordering docs and making PRs referenced here.
    It'll be in a few hours though, after I finish work.

  14. brendanashworth
    added
    good first issueIssues that are suitable for first-time contributors.
    and removed
    discussIssues opened for discussion and feedback.
    on Jun 8, 2015

  15. Fishrock123 commented on Jun 24, 2015

    @Fishrock123
    Fishrock123
    on Jun 24, 2015
    Contributor

    @chrisdickinson could you take this up to discuss in the docs WG?

  16. Fishrock123 commented on Jul 28, 2015

    @Fishrock123
    Fishrock123
    on Jul 28, 2015
    Contributor

    Ok so, the main concern here was that we'd have conflicts pulling over joyent/node doc changes.

    Since we are now the authoritative source, it's not really an issue anymore. I think we should go ahead with this.

    cc @nodejs/documentation

  17. thefourtheye commented on Jul 28, 2015

    @thefourtheye
    thefourtheye
    on Jul 28, 2015
    Contributor

    Formal +1

  18. Qard commented on Aug 14, 2015

    @Qard
    Qard
    on Aug 14, 2015
    Member

    👍 from me too.

  19. MattMS commented on Aug 18, 2015

    @MattMS
    MattMS
    on Aug 18, 2015
    Author

    Should I redo #553 with the current docs?

  20. Fishrock123 commented on Aug 18, 2015

    @Fishrock123
    Fishrock123
    on Aug 18, 2015
    Contributor

    @MattMS Sure! :)

  21. sam-github commented on Aug 19, 2015

    @sam-github
    sam-github
    on Aug 19, 2015
    Contributor

    +1

  22. MattMS commented on Aug 19, 2015

    @MattMS
    MattMS
    on Aug 19, 2015
    Author

    Pull request for reordered fs at #2432

  23. MattMS commented on Sep 11, 2015

    @MattMS
    MattMS
    on Sep 11, 2015
    Author

    I closed #2432 to wait for further discussion and confirmation on the best ordering/grouping to use.

  24. brendanashworth commented on Sep 15, 2015

    @brendanashworth
    brendanashworth
    on Sep 15, 2015
    Contributor

    Ref to nodejs/doc-tool#3 (comment).

  25. tflanagan commented on Nov 13, 2015

    @tflanagan
    tflanagan
    on Nov 13, 2015
    Contributor

    This can be closed now! :)

  26. jasnell
    closed this as completedon Nov 13, 2015

  27. jasnell commented on Nov 13, 2015

    @jasnell
    jasnell
    on Nov 13, 2015
    Member

    Thank you @tflanagan for doing the work!

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

    docIssues and PRs related to Node.js documentation.good first issueIssues that are suitable for first-time contributors.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions