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

meta: add issue template for API reference docs #32944

Conversation

DerekNonGeneric
Copy link
Contributor

Prior to this commit, there was no GitHub issue template guiding
users to open issues about gaps in the API reference docs.

Refs: #31123
Closes: nodejs/nodejs.org#2866

Checklist

@nodejs-github-bot nodejs-github-bot added the meta Issues and PRs related to the general management of the project. label Apr 20, 2020
@DerekNonGeneric DerekNonGeneric marked this pull request as draft April 20, 2020 23:33
@DerekNonGeneric DerekNonGeneric force-pushed the feat/api-ref-docs-issue-template branch 3 times, most recently from 20288e3 to 9e331ae Compare April 29, 2020 11:25
@DerekNonGeneric DerekNonGeneric marked this pull request as ready for review April 29, 2020 20:20
@DerekNonGeneric
Copy link
Contributor Author

/cc @nodejs/documentation @mcollina @codebytere for review please

@DerekNonGeneric
Copy link
Contributor Author

/cc @Trott as we may need to start linting these Markdown files

Copy link
Member

@codebytere codebytere left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that this merits its own template - but this as it stands seems to be geared towards an issue grounded in Node.js behavior rather than docs. Can we perhaps remove the sections which would likely not come into play in a docs context?

.github/ISSUE_TEMPLATE/3-api-ref-docs-problem.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/3-api-ref-docs-problem.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/3-api-ref-docs-problem.md Outdated Show resolved Hide resolved
Derek Lewis added 3 commits April 29, 2020 21:17
Prior to this commit, there was no GitHub issue template guiding
users to open issues about gaps in the API reference docs.

Refs: #31123
Closes: nodejs/nodejs.org#2866
@DerekNonGeneric DerekNonGeneric force-pushed the feat/api-ref-docs-issue-template branch from 9e331ae to 4269336 Compare April 30, 2020 01:17
@DerekNonGeneric
Copy link
Contributor Author

@codebytere, your feedback has been incorporated. The potentially unnecessary sections have been removed, which was made possible by slightly modifying the final section to allow for more free-form commentary.

@addaleax addaleax added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Apr 30, 2020
addaleax pushed a commit that referenced this pull request May 9, 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>
@addaleax
Copy link
Member

addaleax commented May 9, 2020

Landed in 3226731

@addaleax addaleax closed this May 9, 2020
codebytere pushed a commit that referenced this pull request 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 codebytere mentioned this pull request May 18, 2020
codebytere pushed a commit that referenced this pull request 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>
@codebytere codebytere mentioned this pull request Jun 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. meta Issues and PRs related to the general management of the project.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Recommended way to file docs issue forms a circularity
7 participants