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

Recommended way to file docs issue forms a circularity #2866

Closed
DerekNonGeneric opened this issue Dec 28, 2019 · 2 comments
Closed

Recommended way to file docs issue forms a circularity #2866

DerekNonGeneric opened this issue Dec 28, 2019 · 2 comments

Comments

@DerekNonGeneric
Copy link
Contributor

DerekNonGeneric commented Dec 28, 2019

This issue is related to user journey.

  • The currently recommended way of filing a documentation-related issue is confusing.
  • There is no documentation-related issue template.

Circularity confusion

The core repo suggests filing an issue in the Node.js website repo (this one).

🌐 Found a problem with nodejs.org?
Please file an issue in the Node.js website repo.

This repo suggests filing an issue in the main Node.js repo (core).

📗 Node.js API Docs
Please open an issue in the main Node.js repo, prefixed with "doc".

These instructions seem wrong and this is probably unintended.

Missing issue template

If the intended way of filing documentation-related issues is in the core repo with the issue title prefixed with "doc", there should probably be an issue template for this. There's a frontmatter field named title that can pre-fill the issue's title field with doc: for people.


I'm not sure if issues are being triaged during the holidays, but this could be medium to high priority item from a documentation perspective.

/cc @nodejs/documentation

@DerekNonGeneric
Copy link
Contributor Author

  • I would like to work on this issue and submit a pull request.

Keep me posted on whether anyone would be available to review it.

@sam-github
Copy link
Contributor

Found a problem with nodejs.org?

^-- should say ".... outside of the docs"

Node.js API Docs
Please open an issue in the main Node.js repo, prefixed with "doc".

This is correct.

Lots of people are around.

Trott pushed a commit to Trott/io.js that referenced this issue Dec 31, 2019
Refs: nodejs/nodejs.org#2866

PR-URL: nodejs#31123
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BridgeAR pushed a commit to nodejs/node that referenced this issue Jan 3, 2020
Refs: nodejs/nodejs.org#2866

PR-URL: #31123
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
targos pushed a commit to nodejs/node that referenced this issue Jan 14, 2020
Refs: nodejs/nodejs.org#2866

PR-URL: #31123
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit to nodejs/node that referenced this issue Feb 6, 2020
Refs: nodejs/nodejs.org#2866

PR-URL: #31123
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
codebytere pushed a commit to nodejs/node that referenced this issue May 11, 2020
Prior to this commit, there was no GitHub issue template guiding
users to open issues about gaps in the API reference docs.

Refs: #31123
PR-URL: #32944
Fixes: nodejs/nodejs.org#2866
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Shelley Vohr <codebytere@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
codebytere pushed a commit to nodejs/node that referenced this issue Jun 7, 2020
Prior to this commit, there was no GitHub issue template guiding
users to open issues about gaps in the API reference docs.

Refs: #31123
PR-URL: #32944
Fixes: nodejs/nodejs.org#2866
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Shelley Vohr <codebytere@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
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

Successfully merging a pull request may close this issue.

2 participants