Recommended way to file docs issue forms a circularity #2866
Comments
Keep me posted on whether anyone would be available to review it. |
^-- should say ".... outside of the docs"
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
This issue is related to user journey.
Circularity confusion
The core repo suggests filing an issue in the Node.js website repo (this one).
This repo suggests filing an issue in the main Node.js repo (core).
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
titlethat can pre-fill the issue's title field withdoc: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
The text was updated successfully, but these errors were encountered: