GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — meta: add issue template for API reference docs by DerekNonGeneric · Pull Request #32944 · nodejs/node

Conversation

@DerekNonGeneric

@DerekNonGeneric DerekNonGeneric commented Apr 20, 2020

Copy link
Copy Markdown
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
  • commit message follows commit guidelines

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@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 commented Apr 29, 2020

Copy link
Copy Markdown
Contributor Author

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@DerekNonGeneric

DerekNonGeneric commented Apr 29, 2020

Copy link
Copy Markdown
Contributor Author

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
jasnell
jasnell approved these changes Apr 29, 2020
View reviewed changes
codebytere
codebytere reviewed Apr 29, 2020
View reviewed changes

@codebytere codebytere left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this 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?

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
DerekNonGeneric reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
Comment thread .github/ISSUE_TEMPLATE/3-api-ref-docs-problem.md Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread .github/ISSUE_TEMPLATE/3-api-ref-docs-problem.md Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread .github/ISSUE_TEMPLATE/3-api-ref-docs-problem.md Resolved

Uh oh!

There was an error while loading. Please reload this page.
Derek Lewis added 3 commits April 29, 2020 21:17
meta: add issue template for API reference docs
68242dc 
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
fixup! meta: add issue template for API reference docs
7d7d927
fixup! meta: add issue template for API reference docs
4269336
@DerekNonGeneric

DerekNonGeneric commented Apr 30, 2020

Copy link
Copy Markdown
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.
codebytere reacted with rocket emoji
All reactions
  • 🚀 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
addaleax
addaleax approved these changes Apr 30, 2020
View reviewed changes
@addaleax addaleax added the author ready PRs with CI started, the required approvals, and no outstanding review comments. label Apr 30, 2020
gireeshpunathil
gireeshpunathil approved these changes Apr 30, 2020
View reviewed changes
Comment thread .github/ISSUE_TEMPLATE/3-api-ref-docs-problem.md Resolved

Uh oh!

There was an error while loading. Please reload this page.
codebytere
codebytere approved these changes Apr 30, 2020
View reviewed changes
trivikr
trivikr approved these changes May 7, 2020
View reviewed changes
addaleax pushed a commit that referenced this pull request May 9, 2020
@addaleax
meta: add issue template for API reference docs
3226731 
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 <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Gireesh Punathil <[email protected]>
Reviewed-By: Shelley Vohr <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
@addaleax

addaleax commented May 9, 2020

Copy link
Copy Markdown
Member

Landed in 3226731
DerekNonGeneric reacted with hooray emoji
All reactions
  • 🎉 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@addaleax addaleax closed this May 9, 2020
codebytere pushed a commit that referenced this pull request May 11, 2020
@codebytere
meta: add issue template for API reference docs
0a78925 
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 <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Gireesh Punathil <[email protected]>
Reviewed-By: Shelley Vohr <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
@codebytere codebytere mentioned this pull request May 18, 2020
v14.3.0 proposal #33452
Merged
codebytere pushed a commit that referenced this pull request Jun 7, 2020
@codebytere
meta: add issue template for API reference docs
d64dbfa 
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 <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Gireesh Punathil <[email protected]>
Reviewed-By: Shelley Vohr <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
@codebytere codebytere mentioned this pull request Jun 9, 2020
v12.18.1 proposal #33811
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jasnell jasnell jasnell approved these changes
@addaleax addaleax addaleax approved these changes
@codebytere codebytere codebytere approved these changes
@gireeshpunathil gireeshpunathil gireeshpunathil approved these changes
@trivikr trivikr trivikr approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

author ready PRs with CI started, the required approvals, and no outstanding review comments. meta Issues and PRs related to the general management of the project.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Recommended way to file docs issue forms a circularity

Uh oh!

There was an error while loading. Please reload this page.

7 participants

@DerekNonGeneric @addaleax @jasnell @codebytere @gireeshpunathil @trivikr @nodejs-github-bot
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.