Skip to content

Discuss renaming doc/guides #23315

Closed
Closed
Discuss renaming doc/guides#23315
Labels
discussIssues opened for discussion and feedback.docIssues and PRs related to Node.js documentation.metaIssues and PRs related to the general management of the project.stalledIssues and PRs manually marked as stalled and scheduled for automatic closure.

Description

@gabrielschulhof
gabrielschulhof
opened on Oct 7, 2018

In #23287 (comment), @Trott wrote:

Also: The whole "things called 'guides' are in two different places and mean subtly different things, and oh yeah the website is generated in this repo over here except for the docs which are generated over here".... If there's some way that information could have been something could have been surfaced naturally, I'd love to hear what it is. Because that stuff is confusing and probably only a few people know it.

Maybe the guides directory in this repo can be renamed to something that makes it clear they are internal to the project and/or moved out of docs?

Maybe a bot can comment on any PR that adds a new file to the docs/guides letting the user know that these guides are for internal use and if they meant to create something for end users, then they should close this PR and open a new PR over in this other repo?

Other ideas?

Activity

  1. gabrielschulhof commented on Oct 7, 2018

    @gabrielschulhof
    gabrielschulhof
    on Oct 7, 2018
    ContributorAuthor

    doc/contribution_guides?

  2. vsemozhetbyt
    added
    docIssues and PRs related to Node.js documentation.
    discussIssues opened for discussion and feedback.
    metaIssues and PRs related to the general management of the project.
    on Oct 7, 2018

  3. richardlau commented on Oct 8, 2018

    @richardlau
    richardlau
    on Oct 8, 2018
    Member

    Maybe the guides directory in this repo can be renamed to something that makes it clear they are internal to the project and/or moved out of docs?

    We could also put a readme.md in docs/guides for anyone browsing through the GitHub UI?

  4. mhdawson commented on Oct 9, 2018

    @mhdawson
    mhdawson
    on Oct 9, 2018
    Member

    I like the idea of a bot with auto comments.

  5. Trott commented on Nov 6, 2018

    @Trott
    Trott
    on Nov 6, 2018
    Member

    This conversation seems to have stalled or run its course or something. Feel free to re-open if I'm wrong to close it. And, of course, PRs can also be opened for any desired changes.

  6. Trott
    closed this as completedon Nov 6, 2018
  7. Trott
    added
    stalledIssues and PRs manually marked as stalled and scheduled for automatic closure.
    on Nov 6, 2018
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

    discussIssues opened for discussion and feedback.docIssues and PRs related to Node.js documentation.metaIssues and PRs related to the general management of the project.stalledIssues and PRs manually marked as stalled and scheduled for automatic closure.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions