From 68242dce5fec7b842d1677f386d8ff2d6ff3703e Mon Sep 17 00:00:00 2001 From: Derek Lewis Date: Mon, 20 Apr 2020 09:56:25 -0400 Subject: [PATCH 1/3] meta: add issue template for API reference docs Prior to this commit, there was no GitHub issue template guiding users to open issues about gaps in the API reference docs. Refs: https://github.com/nodejs/node/pull/31123 Closes: https://github.com/nodejs/nodejs.org/issues/2866 --- .../ISSUE_TEMPLATE/3-api-ref-docs-problem.md | 74 +++++++++++++++++++ 1 file changed, 74 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/3-api-ref-docs-problem.md diff --git a/.github/ISSUE_TEMPLATE/3-api-ref-docs-problem.md b/.github/ISSUE_TEMPLATE/3-api-ref-docs-problem.md new file mode 100644 index 00000000000000..d33ed1598a6620 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-api-ref-docs-problem.md @@ -0,0 +1,74 @@ +--- +name: "\U0001F4D7 Open an issue regarding the nodejs.org API reference docs" +about: Let us know about any problematic API reference documents +title: "doc: " +labels: doc +--- + +# 📗 API Reference Docs Problem + + + +- **Version**: ✍️ +- **Platform**: ✍️ +- **Subsystem**: ✍️ + +## Problem type + + + +- [ ] Missing +- [ ] Needed +- [ ] Confusing +- [ ] Didn't work +- [ ] Other () + +## Location + +_Section of the site where the content lives (or should)._ + +Affected URL(s): + +- https://nodejs.org/api/✍️ + +## Reproduction procedure + +_Steps to reproduce the problem_ + +✍️ + +## Expected behavior/code + +_What you were expecting._ + +✍️ + +## Additional information + +_Any other information that would be helpful to solve this._ + + + +✍️ + +--- + + + +- [ ] I would like to work on this issue and submit a pull request. From 7d7d92778ec79631d847e8fef0b86b664ca29f73 Mon Sep 17 00:00:00 2001 From: Derek Lewis Date: Wed, 29 Apr 2020 03:29:49 -0400 Subject: [PATCH 2/3] fixup! meta: add issue template for API reference docs --- .../ISSUE_TEMPLATE/3-api-ref-docs-problem.md | 44 +++++++++---------- 1 file changed, 21 insertions(+), 23 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/3-api-ref-docs-problem.md b/.github/ISSUE_TEMPLATE/3-api-ref-docs-problem.md index d33ed1598a6620..a20643447df209 100644 --- a/.github/ISSUE_TEMPLATE/3-api-ref-docs-problem.md +++ b/.github/ISSUE_TEMPLATE/3-api-ref-docs-problem.md @@ -1,5 +1,5 @@ --- -name: "\U0001F4D7 Open an issue regarding the nodejs.org API reference docs" +name: "\U0001F4D7 Open an issue regarding the Node.js API reference docs" about: Let us know about any problematic API reference documents title: "doc: " labels: doc @@ -7,19 +7,22 @@ labels: doc # 📗 API Reference Docs Problem - + - -- [ ] Missing -- [ ] Needed -- [ ] Confusing -- [ ] Didn't work -- [ ] Other () - ## Location -_Section of the site where the content lives (or should)._ +_Section of the site where the content exists (or should)_ Affected URL(s): - - https://nodejs.org/api/✍️ ## Reproduction procedure @@ -55,20 +47,26 @@ _Steps to reproduce the problem_ ## Expected behavior/code -_What you were expecting._ +_What your expectation was_ + +✍️ + +## Actual behavior/code + +_What you found to be problematic_ ✍️ ## Additional information -_Any other information that would be helpful to solve this._ +_Anything else (e.g., screenshots, etc.) that may help solve the problem_ - + ✍️ --- - + - [ ] I would like to work on this issue and submit a pull request. From 426933642f07854814cf435c4ac57cbf6fa7a7d5 Mon Sep 17 00:00:00 2001 From: Derek Lewis Date: Wed, 29 Apr 2020 21:14:50 -0400 Subject: [PATCH 3/3] fixup! meta: add issue template for API reference docs --- .../ISSUE_TEMPLATE/3-api-ref-docs-problem.md | 26 +++---------------- 1 file changed, 4 insertions(+), 22 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/3-api-ref-docs-problem.md b/.github/ISSUE_TEMPLATE/3-api-ref-docs-problem.md index a20643447df209..3ec3959eb67173 100644 --- a/.github/ISSUE_TEMPLATE/3-api-ref-docs-problem.md +++ b/.github/ISSUE_TEMPLATE/3-api-ref-docs-problem.md @@ -34,34 +34,16 @@ Subsystem: if known, please specify affected core module name ## Location -_Section of the site where the content exists (or should)_ +_Section of the site where the content exists_ Affected URL(s): - https://nodejs.org/api/✍️ -## Reproduction procedure +## Problem description -_Steps to reproduce the problem_ +_Concise explanation of what you found to be problematic_ -✍️ - -## Expected behavior/code - -_What your expectation was_ - -✍️ - -## Actual behavior/code - -_What you found to be problematic_ - -✍️ - -## Additional information - -_Anything else (e.g., screenshots, etc.) that may help solve the problem_ - - + ✍️