From 86ddb9e5738cb1f721f22e4888ac10f1f276077e Mon Sep 17 00:00:00 2001 From: Janice Date: Tue, 19 Jan 2021 16:02:29 -0700 Subject: [PATCH 01/21] Update issue templates --- .../ISSUE_TEMPLATE/improve-existing-docs.md | 33 ------------ .../ISSUE_TEMPLATE/improve-existing-docs.yml | 52 +++++++++++++++++++ 2 files changed, 52 insertions(+), 33 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/improve-existing-docs.md create mode 100644 .github/ISSUE_TEMPLATE/improve-existing-docs.yml diff --git a/.github/ISSUE_TEMPLATE/improve-existing-docs.md b/.github/ISSUE_TEMPLATE/improve-existing-docs.md deleted file mode 100644 index 26d822b9a4..0000000000 --- a/.github/ISSUE_TEMPLATE/improve-existing-docs.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: Improve existing docs -about: Make a suggestion to improve our existing documentation. -title: '' -labels: -- content -assignees: '' ---- - - - - -### What article on docs.github.com is affected? - - - -### What part(s) of the article would you like to see updated? - - - -### Additional information - - diff --git a/.github/ISSUE_TEMPLATE/improve-existing-docs.yml b/.github/ISSUE_TEMPLATE/improve-existing-docs.yml new file mode 100644 index 0000000000..55a14ec0fe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/improve-existing-docs.yml @@ -0,0 +1,52 @@ +name: Improve existing docs +about: Make a suggestion to improve our existing documentation. +title: '' +labels: "content" +inputs: +- type: description + attributes: + value: HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. + + For questions, ask in Discussions: https://github.com/github/docs/discussions +- type: checkboxes + attributes: + label: Code of Conduct + description: + all-required: true + choices: + - value: I agree to follow the Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md +- type: checkboxes + attributes: + label: Code of Conduct + description: + all-required: true + choices: + - value: I have read the Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md +- type: checkboxes + attributes: + label: Code of Conduct + description: + all-required: true + choices: + - value: There is not a similar issue that has been already opened: https://github.com/github/docs/issues +- type: textarea + attributes: + label: which article + description: What article on docs.github.com is affected? + required: true + placeholder: Add a link to the article you'd like to see updated + value: +- type: textarea + attributes: + label: desired updates + description: What part(s) of the article would you like to see updated? + required: true + placeholder: Give as much detail as you can to help us understand the change you want to see. Why should the docs be changed? What use cases does it support? What is the expected outcome? + value: +- type: textarea + attributes: + label: additional info + description: Additional information + required: false + placeholder: Add any other context or screenshots about the feature request here. + value: From ec72465a1b9040bbfcf67fe8cb301813d72d38f0 Mon Sep 17 00:00:00 2001 From: Janice Date: Tue, 19 Jan 2021 16:25:15 -0700 Subject: [PATCH 02/21] remove checkboxes (not supported) --- .../ISSUE_TEMPLATE/improve-existing-docs.yml | 42 ++++++++++++------- 1 file changed, 27 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/improve-existing-docs.yml b/.github/ISSUE_TEMPLATE/improve-existing-docs.yml index 55a14ec0fe..7fc356ca49 100644 --- a/.github/ISSUE_TEMPLATE/improve-existing-docs.yml +++ b/.github/ISSUE_TEMPLATE/improve-existing-docs.yml @@ -8,27 +8,39 @@ inputs: value: HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. For questions, ask in Discussions: https://github.com/github/docs/discussions -- type: checkboxes +- type: dropdown + label: Code of Conduct attributes: - label: Code of Conduct - description: - all-required: true choices: - - value: I agree to follow the Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md -- type: checkboxes + - description: I agree to follow the Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + required: true + multi-select: false + free-text: false + choices: + - description: I agree + value: I agree +- type: dropdown + label: Contributing attributes: - label: Code of Conduct - description: - all-required: true choices: - - value: I have read the Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md -- type: checkboxes + - description: I have read the Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md + required: true + multi-select: false + free-text: false + choices: + - description: I agree + value: I agree +- type: dropdown + label: Similar issue attributes: - label: Code of Conduct - description: - all-required: true choices: - - value: There is not a similar issue that has been already opened: https://github.com/github/docs/issues + - description: There is not a similar issue that has been already opened: https://github.com/github/docs/issues + required: true + multi-select: false + free-text: false + choices: + - description: No similar issues + value: No similar issues - type: textarea attributes: label: which article From 710b06ded3b875c916a954f690a828960edb96ff Mon Sep 17 00:00:00 2001 From: Janice Niemeir Date: Tue, 19 Jan 2021 16:41:28 -0700 Subject: [PATCH 03/21] update engineering template --- .github/ISSUE_TEMPLATE/improve-the-site.md | 33 ----------- .github/ISSUE_TEMPLATE/improve-the-site.yml | 64 +++++++++++++++++++++ 2 files changed, 64 insertions(+), 33 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/improve-the-site.md create mode 100644 .github/ISSUE_TEMPLATE/improve-the-site.yml diff --git a/.github/ISSUE_TEMPLATE/improve-the-site.md b/.github/ISSUE_TEMPLATE/improve-the-site.md deleted file mode 100644 index a79f8ed100..0000000000 --- a/.github/ISSUE_TEMPLATE/improve-the-site.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: Improve the docs.github.com site -about: Make a suggestions or report a problem on the docs.github.com website. -title: '' -labels: engineering -assignees: '' ---- - - - - - -### What is the current behavior? - - - -### What changes are you suggesting? - - - -### Additional information - - diff --git a/.github/ISSUE_TEMPLATE/improve-the-site.yml b/.github/ISSUE_TEMPLATE/improve-the-site.yml new file mode 100644 index 0000000000..6e6ba03033 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/improve-the-site.yml @@ -0,0 +1,64 @@ +name: Improve the docs.github.com site +about: Make a suggestions or report a problem on the docs.github.com website. +title: '' +labels: "engineering" +inputs: +- type: description + attributes: + value: HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. + + For questions, ask in Discussions: https://github.com/github/docs/discussions +- type: dropdown + label: Code of Conduct + attributes: + choices: + - description: I agree to follow the Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + required: true + multi-select: false + free-text: false + choices: + - description: I agree + value: I agree +- type: dropdown + label: Contributing + attributes: + choices: + - description: I have read the Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md + required: true + multi-select: false + free-text: false + choices: + - description: I agree + value: I agree +- type: dropdown + label: Similar issue + attributes: + choices: + - description: There is not a similar issue that has been already opened: https://github.com/github/docs/issues + required: true + multi-select: false + free-text: false + choices: + - description: No similar issues + value: No similar issues +- type: textarea + attributes: + label: which article + description: What is the current behavior? + required: true + placeholder: Include links to articles where you're seeing a problem, screenshots, what browser you're using, etc. + value: +- type: textarea + attributes: + label: desired updates + description: What changes are you suggesting? + required: true + placeholder: Give as much detail as you can to help us understand the change you want to see. Why should the docs be changed? What use cases does it support? What is the expected outcome? + value: +- type: textarea + attributes: + label: additional info + description: Additional information + required: false + placeholder: Any additional information, configuration, or data that might be necessary to reproduce the issue. + value: \ No newline at end of file From 1e06ed50c14fb1a83cf88b808276266528819480 Mon Sep 17 00:00:00 2001 From: Janice Niemeir Date: Tue, 19 Jan 2021 16:54:04 -0700 Subject: [PATCH 04/21] un-grump linter errors --- .github/ISSUE_TEMPLATE/improve-existing-docs.yml | 10 +++++----- .github/ISSUE_TEMPLATE/improve-the-site.yml | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/improve-existing-docs.yml b/.github/ISSUE_TEMPLATE/improve-existing-docs.yml index 7fc356ca49..f57e46afb4 100644 --- a/.github/ISSUE_TEMPLATE/improve-existing-docs.yml +++ b/.github/ISSUE_TEMPLATE/improve-existing-docs.yml @@ -5,14 +5,14 @@ labels: "content" inputs: - type: description attributes: - value: HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. + value: 'HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. - For questions, ask in Discussions: https://github.com/github/docs/discussions + For questions, ask in Discussions: https://github.com/github/docs/discussions' - type: dropdown label: Code of Conduct attributes: choices: - - description: I agree to follow the Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + - description: 'I agree to follow the Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md' required: true multi-select: false free-text: false @@ -23,7 +23,7 @@ inputs: label: Contributing attributes: choices: - - description: I have read the Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md + - description: 'I have read the Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md' required: true multi-select: false free-text: false @@ -34,7 +34,7 @@ inputs: label: Similar issue attributes: choices: - - description: There is not a similar issue that has been already opened: https://github.com/github/docs/issues + - description: 'There is not a similar issue that has been already opened: https://github.com/github/docs/issues' required: true multi-select: false free-text: false diff --git a/.github/ISSUE_TEMPLATE/improve-the-site.yml b/.github/ISSUE_TEMPLATE/improve-the-site.yml index 6e6ba03033..d50059c5ee 100644 --- a/.github/ISSUE_TEMPLATE/improve-the-site.yml +++ b/.github/ISSUE_TEMPLATE/improve-the-site.yml @@ -5,14 +5,14 @@ labels: "engineering" inputs: - type: description attributes: - value: HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. + value: 'HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. - For questions, ask in Discussions: https://github.com/github/docs/discussions + For questions, ask in Discussions: https://github.com/github/docs/discussions' - type: dropdown label: Code of Conduct attributes: choices: - - description: I agree to follow the Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + - description: 'I agree to follow the Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md' required: true multi-select: false free-text: false @@ -23,7 +23,7 @@ inputs: label: Contributing attributes: choices: - - description: I have read the Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md + - description: 'I have read the Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md' required: true multi-select: false free-text: false @@ -34,7 +34,7 @@ inputs: label: Similar issue attributes: choices: - - description: There is not a similar issue that has been already opened: https://github.com/github/docs/issues + - description: 'There is not a similar issue that has been already opened: https://github.com/github/docs/issues' required: true multi-select: false free-text: false From 6bdc55f866547bfbcf7a8b15cb7f5d464c501b4c Mon Sep 17 00:00:00 2001 From: Janice Niemeir Date: Wed, 20 Jan 2021 14:31:39 -0700 Subject: [PATCH 05/21] incorporated lee's :sparkles: suggestions! --- .github/ISSUE_TEMPLATE/improve-existing-docs.yml | 10 ++++------ .github/ISSUE_TEMPLATE/improve-the-site.yml | 12 +++++------- 2 files changed, 9 insertions(+), 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/improve-existing-docs.yml b/.github/ISSUE_TEMPLATE/improve-existing-docs.yml index f57e46afb4..c820ae0867 100644 --- a/.github/ISSUE_TEMPLATE/improve-existing-docs.yml +++ b/.github/ISSUE_TEMPLATE/improve-existing-docs.yml @@ -1,13 +1,13 @@ name: Improve existing docs about: Make a suggestion to improve our existing documentation. -title: '' -labels: "content" +labels: content inputs: - type: description attributes: - value: 'HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. + value: | + HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. - For questions, ask in Discussions: https://github.com/github/docs/discussions' + For questions, ask in Discussions: https://github.com/github/docs/discussions' - type: dropdown label: Code of Conduct attributes: @@ -54,11 +54,9 @@ inputs: description: What part(s) of the article would you like to see updated? required: true placeholder: Give as much detail as you can to help us understand the change you want to see. Why should the docs be changed? What use cases does it support? What is the expected outcome? - value: - type: textarea attributes: label: additional info description: Additional information required: false placeholder: Add any other context or screenshots about the feature request here. - value: diff --git a/.github/ISSUE_TEMPLATE/improve-the-site.yml b/.github/ISSUE_TEMPLATE/improve-the-site.yml index d50059c5ee..9748e2e0ad 100644 --- a/.github/ISSUE_TEMPLATE/improve-the-site.yml +++ b/.github/ISSUE_TEMPLATE/improve-the-site.yml @@ -1,13 +1,13 @@ name: Improve the docs.github.com site about: Make a suggestions or report a problem on the docs.github.com website. -title: '' -labels: "engineering" +labels: engineering inputs: - type: description attributes: - value: 'HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. + value: | + HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. - For questions, ask in Discussions: https://github.com/github/docs/discussions' + For questions, ask in Discussions: https://github.com/github/docs/discussions' - type: dropdown label: Code of Conduct attributes: @@ -54,11 +54,9 @@ inputs: description: What changes are you suggesting? required: true placeholder: Give as much detail as you can to help us understand the change you want to see. Why should the docs be changed? What use cases does it support? What is the expected outcome? - value: - type: textarea attributes: label: additional info description: Additional information required: false - placeholder: Any additional information, configuration, or data that might be necessary to reproduce the issue. - value: \ No newline at end of file + placeholder: Any additional information, configuration, or data that might be necessary to reproduce the issue. \ No newline at end of file From 2fa197249215cc36b527be1752eb1ac09509d342 Mon Sep 17 00:00:00 2001 From: Janice Date: Wed, 20 Jan 2021 15:29:53 -0700 Subject: [PATCH 06/21] Update .github/ISSUE_TEMPLATE/improve-existing-docs.yml Co-authored-by: Lee Dohm <1038121+lee-dohm@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/improve-existing-docs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/improve-existing-docs.yml b/.github/ISSUE_TEMPLATE/improve-existing-docs.yml index c820ae0867..db00e37eb6 100644 --- a/.github/ISSUE_TEMPLATE/improve-existing-docs.yml +++ b/.github/ISSUE_TEMPLATE/improve-existing-docs.yml @@ -5,9 +5,9 @@ inputs: - type: description attributes: value: | - HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. + HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. - For questions, ask in Discussions: https://github.com/github/docs/discussions' + For questions, ask in Discussions: https://github.com/github/docs/discussions' - type: dropdown label: Code of Conduct attributes: From 1996932bae59872416cab6b90ce17141f0625a75 Mon Sep 17 00:00:00 2001 From: Janice Niemeir Date: Wed, 20 Jan 2021 15:30:22 -0700 Subject: [PATCH 07/21] add intentation --- .github/ISSUE_TEMPLATE/improve-the-site.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/improve-the-site.yml b/.github/ISSUE_TEMPLATE/improve-the-site.yml index 9748e2e0ad..df1a034189 100644 --- a/.github/ISSUE_TEMPLATE/improve-the-site.yml +++ b/.github/ISSUE_TEMPLATE/improve-the-site.yml @@ -5,9 +5,9 @@ inputs: - type: description attributes: value: | - HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. + HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. - For questions, ask in Discussions: https://github.com/github/docs/discussions' + For questions, ask in Discussions: https://github.com/github/docs/discussions' - type: dropdown label: Code of Conduct attributes: From f57c180d795053eab293039f8eb14cd3d33cf26c Mon Sep 17 00:00:00 2001 From: Kevin Heis Date: Thu, 21 Jan 2021 10:02:55 -0800 Subject: [PATCH 08/21] Run linter --- .../ISSUE_TEMPLATE/improve-existing-docs.yml | 108 +++++++++--------- .github/ISSUE_TEMPLATE/improve-the-site.yml | 108 +++++++++--------- 2 files changed, 108 insertions(+), 108 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/improve-existing-docs.yml b/.github/ISSUE_TEMPLATE/improve-existing-docs.yml index db00e37eb6..f05a71d73d 100644 --- a/.github/ISSUE_TEMPLATE/improve-existing-docs.yml +++ b/.github/ISSUE_TEMPLATE/improve-existing-docs.yml @@ -2,61 +2,61 @@ name: Improve existing docs about: Make a suggestion to improve our existing documentation. labels: content inputs: -- type: description - attributes: - value: | - HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. + - type: description + attributes: + value: | + HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. - For questions, ask in Discussions: https://github.com/github/docs/discussions' -- type: dropdown - label: Code of Conduct - attributes: - choices: - - description: 'I agree to follow the Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md' - required: true - multi-select: false - free-text: false + For questions, ask in Discussions: https://github.com/github/docs/discussions' + - type: dropdown + label: Code of Conduct + attributes: choices: - - description: I agree - value: I agree -- type: dropdown - label: Contributing - attributes: - choices: - - description: 'I have read the Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md' - required: true - multi-select: false - free-text: false + - description: 'I agree to follow the Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md' + required: true + multi-select: false + free-text: false + choices: + - description: I agree + value: I agree + - type: dropdown + label: Contributing + attributes: choices: - - description: I agree - value: I agree -- type: dropdown - label: Similar issue - attributes: - choices: - - description: 'There is not a similar issue that has been already opened: https://github.com/github/docs/issues' - required: true - multi-select: false - free-text: false + - description: 'I have read the Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md' + required: true + multi-select: false + free-text: false + choices: + - description: I agree + value: I agree + - type: dropdown + label: Similar issue + attributes: choices: - - description: No similar issues - value: No similar issues -- type: textarea - attributes: - label: which article - description: What article on docs.github.com is affected? - required: true - placeholder: Add a link to the article you'd like to see updated - value: -- type: textarea - attributes: - label: desired updates - description: What part(s) of the article would you like to see updated? - required: true - placeholder: Give as much detail as you can to help us understand the change you want to see. Why should the docs be changed? What use cases does it support? What is the expected outcome? -- type: textarea - attributes: - label: additional info - description: Additional information - required: false - placeholder: Add any other context or screenshots about the feature request here. + - description: 'There is not a similar issue that has been already opened: https://github.com/github/docs/issues' + required: true + multi-select: false + free-text: false + choices: + - description: No similar issues + value: No similar issues + - type: textarea + attributes: + label: which article + description: What article on docs.github.com is affected? + required: true + placeholder: Add a link to the article you'd like to see updated + value: + - type: textarea + attributes: + label: desired updates + description: What part(s) of the article would you like to see updated? + required: true + placeholder: Give as much detail as you can to help us understand the change you want to see. Why should the docs be changed? What use cases does it support? What is the expected outcome? + - type: textarea + attributes: + label: additional info + description: Additional information + required: false + placeholder: Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/improve-the-site.yml b/.github/ISSUE_TEMPLATE/improve-the-site.yml index df1a034189..50f2b6c580 100644 --- a/.github/ISSUE_TEMPLATE/improve-the-site.yml +++ b/.github/ISSUE_TEMPLATE/improve-the-site.yml @@ -2,61 +2,61 @@ name: Improve the docs.github.com site about: Make a suggestions or report a problem on the docs.github.com website. labels: engineering inputs: -- type: description - attributes: - value: | - HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. + - type: description + attributes: + value: | + HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. - For questions, ask in Discussions: https://github.com/github/docs/discussions' -- type: dropdown - label: Code of Conduct - attributes: - choices: - - description: 'I agree to follow the Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md' - required: true - multi-select: false - free-text: false + For questions, ask in Discussions: https://github.com/github/docs/discussions' + - type: dropdown + label: Code of Conduct + attributes: choices: - - description: I agree - value: I agree -- type: dropdown - label: Contributing - attributes: - choices: - - description: 'I have read the Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md' - required: true - multi-select: false - free-text: false + - description: 'I agree to follow the Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md' + required: true + multi-select: false + free-text: false + choices: + - description: I agree + value: I agree + - type: dropdown + label: Contributing + attributes: choices: - - description: I agree - value: I agree -- type: dropdown - label: Similar issue - attributes: - choices: - - description: 'There is not a similar issue that has been already opened: https://github.com/github/docs/issues' - required: true - multi-select: false - free-text: false + - description: 'I have read the Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md' + required: true + multi-select: false + free-text: false + choices: + - description: I agree + value: I agree + - type: dropdown + label: Similar issue + attributes: choices: - - description: No similar issues - value: No similar issues -- type: textarea - attributes: - label: which article - description: What is the current behavior? - required: true - placeholder: Include links to articles where you're seeing a problem, screenshots, what browser you're using, etc. - value: -- type: textarea - attributes: - label: desired updates - description: What changes are you suggesting? - required: true - placeholder: Give as much detail as you can to help us understand the change you want to see. Why should the docs be changed? What use cases does it support? What is the expected outcome? -- type: textarea - attributes: - label: additional info - description: Additional information - required: false - placeholder: Any additional information, configuration, or data that might be necessary to reproduce the issue. \ No newline at end of file + - description: 'There is not a similar issue that has been already opened: https://github.com/github/docs/issues' + required: true + multi-select: false + free-text: false + choices: + - description: No similar issues + value: No similar issues + - type: textarea + attributes: + label: which article + description: What is the current behavior? + required: true + placeholder: Include links to articles where you're seeing a problem, screenshots, what browser you're using, etc. + value: + - type: textarea + attributes: + label: desired updates + description: What changes are you suggesting? + required: true + placeholder: Give as much detail as you can to help us understand the change you want to see. Why should the docs be changed? What use cases does it support? What is the expected outcome? + - type: textarea + attributes: + label: additional info + description: Additional information + required: false + placeholder: Any additional information, configuration, or data that might be necessary to reproduce the issue. From c0acc955ee566c116a80a895f7dd83590471eec5 Mon Sep 17 00:00:00 2001 From: Janice Date: Mon, 25 Jan 2021 08:24:28 -0700 Subject: [PATCH 09/21] Update .github/ISSUE_TEMPLATE/improve-the-site.yml --- .github/ISSUE_TEMPLATE/improve-the-site.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/improve-the-site.yml b/.github/ISSUE_TEMPLATE/improve-the-site.yml index 50f2b6c580..24a7b2cd5e 100644 --- a/.github/ISSUE_TEMPLATE/improve-the-site.yml +++ b/.github/ISSUE_TEMPLATE/improve-the-site.yml @@ -7,7 +7,7 @@ inputs: value: | HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. - For questions, ask in Discussions: https://github.com/github/docs/discussions' + For questions, ask in Discussions: https://github.com/github/docs/discussions - type: dropdown label: Code of Conduct attributes: From 929f09270a4f7f3774eba19d6473a7cb30328eb1 Mon Sep 17 00:00:00 2001 From: Janice Date: Mon, 25 Jan 2021 08:31:59 -0700 Subject: [PATCH 10/21] Update .github/ISSUE_TEMPLATE/improve-existing-docs.yml --- .github/ISSUE_TEMPLATE/improve-existing-docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/improve-existing-docs.yml b/.github/ISSUE_TEMPLATE/improve-existing-docs.yml index f05a71d73d..31f99f653b 100644 --- a/.github/ISSUE_TEMPLATE/improve-existing-docs.yml +++ b/.github/ISSUE_TEMPLATE/improve-existing-docs.yml @@ -7,7 +7,7 @@ inputs: value: | HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. - For questions, ask in Discussions: https://github.com/github/docs/discussions' + For questions, ask in Discussions: https://github.com/github/docs/discussions - type: dropdown label: Code of Conduct attributes: From 81e20bd4a34eed785cc580dbc65b4c759e9f7b8d Mon Sep 17 00:00:00 2001 From: Janice Date: Mon, 25 Jan 2021 15:58:41 -0700 Subject: [PATCH 11/21] Update .github/ISSUE_TEMPLATE/improve-the-site.yml --- .github/ISSUE_TEMPLATE/improve-the-site.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/improve-the-site.yml b/.github/ISSUE_TEMPLATE/improve-the-site.yml index 24a7b2cd5e..187683e929 100644 --- a/.github/ISSUE_TEMPLATE/improve-the-site.yml +++ b/.github/ISSUE_TEMPLATE/improve-the-site.yml @@ -1,4 +1,4 @@ -name: Improve the docs.github.com site +name: Suggest ideas and updates for the Docs website about: Make a suggestions or report a problem on the docs.github.com website. labels: engineering inputs: From 17321de2c37b0738365ae4645274c0cae6164327 Mon Sep 17 00:00:00 2001 From: Janice Niemeir Date: Mon, 25 Jan 2021 16:06:08 -0700 Subject: [PATCH 12/21] Update site text areas with @chiedo's suggestions --- .github/ISSUE_TEMPLATE/improve-the-site.yml | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/improve-the-site.yml b/.github/ISSUE_TEMPLATE/improve-the-site.yml index 187683e929..514faeb7a5 100644 --- a/.github/ISSUE_TEMPLATE/improve-the-site.yml +++ b/.github/ISSUE_TEMPLATE/improve-the-site.yml @@ -43,17 +43,10 @@ inputs: value: No similar issues - type: textarea attributes: - label: which article - description: What is the current behavior? - required: true - placeholder: Include links to articles where you're seeing a problem, screenshots, what browser you're using, etc. - value: - - type: textarea - attributes: - label: desired updates + label: suggestion description: What changes are you suggesting? required: true - placeholder: Give as much detail as you can to help us understand the change you want to see. Why should the docs be changed? What use cases does it support? What is the expected outcome? + placeholder: Explain, in writing, with as much detail as possible, what changes you're suggesting and why. Provide supporting information using screenshots and URLs where possible, to help us understand your suggested changes. - type: textarea attributes: label: additional info From 5ad795a66d50495831214f383b99d08a8e488bad Mon Sep 17 00:00:00 2001 From: Janice Date: Tue, 26 Jan 2021 11:18:08 -0700 Subject: [PATCH 13/21] Update .github/ISSUE_TEMPLATE/improve-the-site.yml --- .github/ISSUE_TEMPLATE/improve-the-site.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/improve-the-site.yml b/.github/ISSUE_TEMPLATE/improve-the-site.yml index 514faeb7a5..5648c10cb8 100644 --- a/.github/ISSUE_TEMPLATE/improve-the-site.yml +++ b/.github/ISSUE_TEMPLATE/improve-the-site.yml @@ -5,7 +5,7 @@ inputs: - type: description attributes: value: | - HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. + HUBBERS BEWARE! Please confirm you're on the github/docs-internal repo and not the github/docs repo before proceeding, unless you want to make your work public to the entire internet. The github/docs repo is open source and public to the entire internet. For questions, ask in Discussions: https://github.com/github/docs/discussions - type: dropdown From bece5e2e93ed8a65e9565938cbea54d02bc0e219 Mon Sep 17 00:00:00 2001 From: Janice Niemeir Date: Mon, 1 Feb 2021 15:08:01 -0700 Subject: [PATCH 14/21] rename from .yml to .yaml --- .../{improve-existing-docs.yml => improve-existing-docs.yaml} | 0 .../{improve-the-site.yml => improve-the-site.yaml} | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename .github/ISSUE_TEMPLATE/{improve-existing-docs.yml => improve-existing-docs.yaml} (100%) rename .github/ISSUE_TEMPLATE/{improve-the-site.yml => improve-the-site.yaml} (100%) diff --git a/.github/ISSUE_TEMPLATE/improve-existing-docs.yml b/.github/ISSUE_TEMPLATE/improve-existing-docs.yaml similarity index 100% rename from .github/ISSUE_TEMPLATE/improve-existing-docs.yml rename to .github/ISSUE_TEMPLATE/improve-existing-docs.yaml diff --git a/.github/ISSUE_TEMPLATE/improve-the-site.yml b/.github/ISSUE_TEMPLATE/improve-the-site.yaml similarity index 100% rename from .github/ISSUE_TEMPLATE/improve-the-site.yml rename to .github/ISSUE_TEMPLATE/improve-the-site.yaml From f15d9d3aac65931f579101e676f95d470c5f83bc Mon Sep 17 00:00:00 2001 From: Janice Niemeir Date: Mon, 1 Feb 2021 15:11:48 -0700 Subject: [PATCH 15/21] Add `---` to the first line --- .github/ISSUE_TEMPLATE/improve-existing-docs.yaml | 1 + .github/ISSUE_TEMPLATE/improve-the-site.yaml | 1 + 2 files changed, 2 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/improve-existing-docs.yaml b/.github/ISSUE_TEMPLATE/improve-existing-docs.yaml index 31f99f653b..af2aacd932 100644 --- a/.github/ISSUE_TEMPLATE/improve-existing-docs.yaml +++ b/.github/ISSUE_TEMPLATE/improve-existing-docs.yaml @@ -1,3 +1,4 @@ +--- name: Improve existing docs about: Make a suggestion to improve our existing documentation. labels: content diff --git a/.github/ISSUE_TEMPLATE/improve-the-site.yaml b/.github/ISSUE_TEMPLATE/improve-the-site.yaml index 5648c10cb8..8101a94a0a 100644 --- a/.github/ISSUE_TEMPLATE/improve-the-site.yaml +++ b/.github/ISSUE_TEMPLATE/improve-the-site.yaml @@ -1,3 +1,4 @@ +--- name: Suggest ideas and updates for the Docs website about: Make a suggestions or report a problem on the docs.github.com website. labels: engineering From c6fc0a1c8aa51c3432d60fa2ecce41a270da081f Mon Sep 17 00:00:00 2001 From: Janice Niemeir Date: Mon, 8 Feb 2021 16:03:22 -0700 Subject: [PATCH 16/21] fix yaml --- .../ISSUE_TEMPLATE/improve-existing-docs.yaml | 112 +++++++++--------- .github/ISSUE_TEMPLATE/improve-the-site.yaml | 98 ++++++++------- 2 files changed, 103 insertions(+), 107 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/improve-existing-docs.yaml b/.github/ISSUE_TEMPLATE/improve-existing-docs.yaml index af2aacd932..fdf9a33e61 100644 --- a/.github/ISSUE_TEMPLATE/improve-existing-docs.yaml +++ b/.github/ISSUE_TEMPLATE/improve-existing-docs.yaml @@ -3,61 +3,59 @@ name: Improve existing docs about: Make a suggestion to improve our existing documentation. labels: content inputs: - - type: description - attributes: - value: | - HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. +- type: description + attributes: + value: | + HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. - For questions, ask in Discussions: https://github.com/github/docs/discussions - - type: dropdown - label: Code of Conduct - attributes: - choices: - - description: 'I agree to follow the Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md' - required: true - multi-select: false - free-text: false - choices: - - description: I agree - value: I agree - - type: dropdown - label: Contributing - attributes: - choices: - - description: 'I have read the Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md' - required: true - multi-select: false - free-text: false - choices: - - description: I agree - value: I agree - - type: dropdown - label: Similar issue - attributes: - choices: - - description: 'There is not a similar issue that has been already opened: https://github.com/github/docs/issues' - required: true - multi-select: false - free-text: false - choices: - - description: No similar issues - value: No similar issues - - type: textarea - attributes: - label: which article - description: What article on docs.github.com is affected? - required: true - placeholder: Add a link to the article you'd like to see updated - value: - - type: textarea - attributes: - label: desired updates - description: What part(s) of the article would you like to see updated? - required: true - placeholder: Give as much detail as you can to help us understand the change you want to see. Why should the docs be changed? What use cases does it support? What is the expected outcome? - - type: textarea - attributes: - label: additional info - description: Additional information - required: false - placeholder: Add any other context or screenshots about the feature request here. + For questions, ask in Discussions: https://github.com/github/docs/discussions +- type: checkboxes + label: Code of Conduct + attributes: + label: 'I agree to follow the Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md' + required: true + multi-select: false + free-text: false + choices: + - label: I agree +- type: dropdown + label: Contributing + attributes: + choices: + - description: 'I have read the Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md' + required: true + multi-select: false + free-text: false + choices: + - description: I agree + value: I agree +- type: dropdown + label: Similar issue + attributes: + choices: + - description: 'There is not a similar issue that has been already opened: https://github.com/github/docs/issues' + required: true + multi-select: false + free-text: false + choices: + - description: No similar issues + value: No similar issues +- type: textarea + attributes: + label: which article + description: What article on docs.github.com is affected? + required: true + placeholder: Add a link to the article you'd like to see updated + value: +- type: textarea + attributes: + label: desired updates + description: What part(s) of the article would you like to see updated? + required: true + placeholder: Give as much detail as you can to help us understand the change you want to see. Why should the docs be changed? What use cases does it support? What is the expected outcome? +- type: textarea + attributes: + label: additional info + description: Additional information + required: false + placeholder: Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/improve-the-site.yaml b/.github/ISSUE_TEMPLATE/improve-the-site.yaml index 8101a94a0a..a67097a864 100644 --- a/.github/ISSUE_TEMPLATE/improve-the-site.yaml +++ b/.github/ISSUE_TEMPLATE/improve-the-site.yaml @@ -3,54 +3,52 @@ name: Suggest ideas and updates for the Docs website about: Make a suggestions or report a problem on the docs.github.com website. labels: engineering inputs: - - type: description - attributes: - value: | - HUBBERS BEWARE! Please confirm you're on the github/docs-internal repo and not the github/docs repo before proceeding, unless you want to make your work public to the entire internet. The github/docs repo is open source and public to the entire internet. +- type: description + attributes: + value: | + HUBBERS BEWARE! Please confirm you're on the github/docs-internal repo and not the github/docs repo before proceeding, unless you want to make your work public to the entire internet. The github/docs repo is open source and public to the entire internet. - For questions, ask in Discussions: https://github.com/github/docs/discussions - - type: dropdown - label: Code of Conduct - attributes: - choices: - - description: 'I agree to follow the Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md' - required: true - multi-select: false - free-text: false - choices: - - description: I agree - value: I agree - - type: dropdown - label: Contributing - attributes: - choices: - - description: 'I have read the Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md' - required: true - multi-select: false - free-text: false - choices: - - description: I agree - value: I agree - - type: dropdown - label: Similar issue - attributes: - choices: - - description: 'There is not a similar issue that has been already opened: https://github.com/github/docs/issues' - required: true - multi-select: false - free-text: false - choices: - - description: No similar issues - value: No similar issues - - type: textarea - attributes: - label: suggestion - description: What changes are you suggesting? - required: true - placeholder: Explain, in writing, with as much detail as possible, what changes you're suggesting and why. Provide supporting information using screenshots and URLs where possible, to help us understand your suggested changes. - - type: textarea - attributes: - label: additional info - description: Additional information - required: false - placeholder: Any additional information, configuration, or data that might be necessary to reproduce the issue. + For questions, ask in Discussions: https://github.com/github/docs/discussions +- type: checkboxes + label: Code of Conduct + attributes: + label: 'I agree to follow the Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md' + required: true + multi-select: false + free-text: false + choices: + - label: I agree +- type: dropdown + label: Contributing + attributes: + choices: + - description: 'I have read the Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md' + required: true + multi-select: false + free-text: false + choices: + - description: I agree + value: I agree +- type: dropdown + label: Similar issue + attributes: + choices: + - description: 'There is not a similar issue that has been already opened: https://github.com/github/docs/issues' + required: true + multi-select: false + free-text: false + choices: + - description: No similar issues + value: No similar issues +- type: textarea + attributes: + label: suggestion + description: What changes are you suggesting? + required: true + placeholder: Explain, in writing, with as much detail as possible, what changes you're suggesting and why. Provide supporting information using screenshots and URLs where possible, to help us understand your suggested changes. +- type: textarea + attributes: + label: additional info + description: Additional information + required: false + placeholder: Any additional information, configuration, or data that might be necessary to reproduce the issue. From 68cf76ec145d4b64860dcfb91b79c8b2ea57131c Mon Sep 17 00:00:00 2001 From: Denise Yu Date: Thu, 11 Feb 2021 14:25:29 -0500 Subject: [PATCH 17/21] Convert templates to new format - will work automagically on Feb 19 --- .../ISSUE_TEMPLATE/improve-existing-docs.yaml | 64 ++++++------------- .github/ISSUE_TEMPLATE/improve-the-site.yaml | 52 +++++---------- 2 files changed, 37 insertions(+), 79 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/improve-existing-docs.yaml b/.github/ISSUE_TEMPLATE/improve-existing-docs.yaml index fdf9a33e61..d896af856b 100644 --- a/.github/ISSUE_TEMPLATE/improve-existing-docs.yaml +++ b/.github/ISSUE_TEMPLATE/improve-existing-docs.yaml @@ -2,60 +2,38 @@ name: Improve existing docs about: Make a suggestion to improve our existing documentation. labels: content -inputs: -- type: description +body: +- type: markdown attributes: value: | HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. For questions, ask in Discussions: https://github.com/github/docs/discussions - type: checkboxes - label: Code of Conduct attributes: - label: 'I agree to follow the Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md' - required: true - multi-select: false - free-text: false - choices: - - label: I agree -- type: dropdown - label: Contributing - attributes: - choices: - - description: 'I have read the Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md' - required: true - multi-select: false - free-text: false - choices: - - description: I agree - value: I agree -- type: dropdown - label: Similar issue - attributes: - choices: - - description: 'There is not a similar issue that has been already opened: https://github.com/github/docs/issues' - required: true - multi-select: false - free-text: false - choices: - - description: No similar issues - value: No similar issues + label: Contributing Guidelines + options: + - label: 'I agree to follow the [Code of Conduct](https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md)' + required: true + - label: 'I have read the [Contributing Guide](https://github.com/github/docs/blob/main/CONTRIBUTING.md)' + required: true + - label: 'There is not a similar issue that has been [already opened](https://github.com/github/docs/issues)' + required: true - type: textarea attributes: - label: which article - description: What article on docs.github.com is affected? - required: true + label: Which article? + description: What article on [docs.github.com](https://docs.github.com) is affected? placeholder: Add a link to the article you'd like to see updated - value: -- type: textarea - attributes: - label: desired updates - description: What part(s) of the article would you like to see updated? + validations: required: true - placeholder: Give as much detail as you can to help us understand the change you want to see. Why should the docs be changed? What use cases does it support? What is the expected outcome? - type: textarea attributes: - label: additional info - description: Additional information - required: false + label: Desired Updates + description: What part(s) of the article would you like to see updated? + placeholder: Give as much detail as you can to help us understand the change you want to see. Why should the docs be changed? What use cases does it support? What is the expected outcome? + validations: + required: true +- type: textarea + attributes: + label: Additional Information placeholder: Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/improve-the-site.yaml b/.github/ISSUE_TEMPLATE/improve-the-site.yaml index a67097a864..1860f90330 100644 --- a/.github/ISSUE_TEMPLATE/improve-the-site.yaml +++ b/.github/ISSUE_TEMPLATE/improve-the-site.yaml @@ -2,53 +2,33 @@ name: Suggest ideas and updates for the Docs website about: Make a suggestions or report a problem on the docs.github.com website. labels: engineering -inputs: -- type: description +body: +- type: markdown attributes: value: | HUBBERS BEWARE! Please confirm you're on the github/docs-internal repo and not the github/docs repo before proceeding, unless you want to make your work public to the entire internet. The github/docs repo is open source and public to the entire internet. For questions, ask in Discussions: https://github.com/github/docs/discussions - type: checkboxes - label: Code of Conduct attributes: - label: 'I agree to follow the Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md' - required: true - multi-select: false - free-text: false - choices: - - label: I agree -- type: dropdown - label: Contributing - attributes: - choices: - - description: 'I have read the Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md' - required: true - multi-select: false - free-text: false - choices: - - description: I agree - value: I agree -- type: dropdown - label: Similar issue - attributes: - choices: - - description: 'There is not a similar issue that has been already opened: https://github.com/github/docs/issues' - required: true - multi-select: false - free-text: false - choices: - - description: No similar issues - value: No similar issues + label: Contributing Guidelines + options: + - label: 'I agree to follow the [Code of Conduct](https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md)' + required: true + - label: 'I have read the [Contributing Guide](https://github.com/github/docs/blob/main/CONTRIBUTING.md)' + required: true + - label: 'There is not a similar issue that has been [already opened](https://github.com/github/docs/issues)' + required: true - type: textarea attributes: - label: suggestion + label: Suggestion description: What changes are you suggesting? - required: true placeholder: Explain, in writing, with as much detail as possible, what changes you're suggesting and why. Provide supporting information using screenshots and URLs where possible, to help us understand your suggested changes. + validations: + required: true - type: textarea attributes: - label: additional info - description: Additional information - required: false + label: Additional Information placeholder: Any additional information, configuration, or data that might be necessary to reproduce the issue. + validations: + required: true From f7150c55849d455caf56bb2bfce20dafacce671f Mon Sep 17 00:00:00 2001 From: Rachael Sewell Date: Thu, 18 Feb 2021 13:39:38 -0800 Subject: [PATCH 18/21] run linter --- .../ISSUE_TEMPLATE/improve-existing-docs.yaml | 62 +++++++++---------- .github/ISSUE_TEMPLATE/improve-the-site.yaml | 52 ++++++++-------- 2 files changed, 57 insertions(+), 57 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/improve-existing-docs.yaml b/.github/ISSUE_TEMPLATE/improve-existing-docs.yaml index d896af856b..7203c0a930 100644 --- a/.github/ISSUE_TEMPLATE/improve-existing-docs.yaml +++ b/.github/ISSUE_TEMPLATE/improve-existing-docs.yaml @@ -3,37 +3,37 @@ name: Improve existing docs about: Make a suggestion to improve our existing documentation. labels: content body: -- type: markdown - attributes: - value: | - HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. + - type: markdown + attributes: + value: | + HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. - For questions, ask in Discussions: https://github.com/github/docs/discussions -- type: checkboxes - attributes: - label: Contributing Guidelines - options: - - label: 'I agree to follow the [Code of Conduct](https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md)' + For questions, ask in Discussions: https://github.com/github/docs/discussions + - type: checkboxes + attributes: + label: Contributing Guidelines + options: + - label: 'I agree to follow the [Code of Conduct](https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md)' + required: true + - label: 'I have read the [Contributing Guide](https://github.com/github/docs/blob/main/CONTRIBUTING.md)' + required: true + - label: 'There is not a similar issue that has been [already opened](https://github.com/github/docs/issues)' + required: true + - type: textarea + attributes: + label: Which article? + description: What article on [docs.github.com](https://docs.github.com) is affected? + placeholder: Add a link to the article you'd like to see updated + validations: required: true - - label: 'I have read the [Contributing Guide](https://github.com/github/docs/blob/main/CONTRIBUTING.md)' + - type: textarea + attributes: + label: Desired Updates + description: What part(s) of the article would you like to see updated? + placeholder: Give as much detail as you can to help us understand the change you want to see. Why should the docs be changed? What use cases does it support? What is the expected outcome? + validations: required: true - - label: 'There is not a similar issue that has been [already opened](https://github.com/github/docs/issues)' - required: true -- type: textarea - attributes: - label: Which article? - description: What article on [docs.github.com](https://docs.github.com) is affected? - placeholder: Add a link to the article you'd like to see updated - validations: - required: true -- type: textarea - attributes: - label: Desired Updates - description: What part(s) of the article would you like to see updated? - placeholder: Give as much detail as you can to help us understand the change you want to see. Why should the docs be changed? What use cases does it support? What is the expected outcome? - validations: - required: true -- type: textarea - attributes: - label: Additional Information - placeholder: Add any other context or screenshots about the feature request here. + - type: textarea + attributes: + label: Additional Information + placeholder: Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/improve-the-site.yaml b/.github/ISSUE_TEMPLATE/improve-the-site.yaml index 1860f90330..a811407870 100644 --- a/.github/ISSUE_TEMPLATE/improve-the-site.yaml +++ b/.github/ISSUE_TEMPLATE/improve-the-site.yaml @@ -3,32 +3,32 @@ name: Suggest ideas and updates for the Docs website about: Make a suggestions or report a problem on the docs.github.com website. labels: engineering body: -- type: markdown - attributes: - value: | - HUBBERS BEWARE! Please confirm you're on the github/docs-internal repo and not the github/docs repo before proceeding, unless you want to make your work public to the entire internet. The github/docs repo is open source and public to the entire internet. + - type: markdown + attributes: + value: | + HUBBERS BEWARE! Please confirm you're on the github/docs-internal repo and not the github/docs repo before proceeding, unless you want to make your work public to the entire internet. The github/docs repo is open source and public to the entire internet. - For questions, ask in Discussions: https://github.com/github/docs/discussions -- type: checkboxes - attributes: - label: Contributing Guidelines - options: - - label: 'I agree to follow the [Code of Conduct](https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md)' + For questions, ask in Discussions: https://github.com/github/docs/discussions + - type: checkboxes + attributes: + label: Contributing Guidelines + options: + - label: 'I agree to follow the [Code of Conduct](https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md)' + required: true + - label: 'I have read the [Contributing Guide](https://github.com/github/docs/blob/main/CONTRIBUTING.md)' + required: true + - label: 'There is not a similar issue that has been [already opened](https://github.com/github/docs/issues)' + required: true + - type: textarea + attributes: + label: Suggestion + description: What changes are you suggesting? + placeholder: Explain, in writing, with as much detail as possible, what changes you're suggesting and why. Provide supporting information using screenshots and URLs where possible, to help us understand your suggested changes. + validations: required: true - - label: 'I have read the [Contributing Guide](https://github.com/github/docs/blob/main/CONTRIBUTING.md)' + - type: textarea + attributes: + label: Additional Information + placeholder: Any additional information, configuration, or data that might be necessary to reproduce the issue. + validations: required: true - - label: 'There is not a similar issue that has been [already opened](https://github.com/github/docs/issues)' - required: true -- type: textarea - attributes: - label: Suggestion - description: What changes are you suggesting? - placeholder: Explain, in writing, with as much detail as possible, what changes you're suggesting and why. Provide supporting information using screenshots and URLs where possible, to help us understand your suggested changes. - validations: - required: true -- type: textarea - attributes: - label: Additional Information - placeholder: Any additional information, configuration, or data that might be necessary to reproduce the issue. - validations: - required: true From 380142cb4be283f21a5dcb64c5f44007cc13e89d Mon Sep 17 00:00:00 2001 From: Rachael Sewell Date: Thu, 18 Feb 2021 13:42:48 -0800 Subject: [PATCH 19/21] use `pull_request_target` (#3783) --- .github/workflows/repo-freeze-check.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/repo-freeze-check.yml b/.github/workflows/repo-freeze-check.yml index 7611d3ee54..a1389ba313 100644 --- a/.github/workflows/repo-freeze-check.yml +++ b/.github/workflows/repo-freeze-check.yml @@ -1,7 +1,8 @@ name: Repo Freeze Check on: - pull_request: + workflow_dispatch: + pull_request_target: types: - opened - reopened From e2ba28910fb26a0caac793f79e09a3a91675a36a Mon Sep 17 00:00:00 2001 From: David Wolf Date: Fri, 19 Feb 2021 12:09:25 -0500 Subject: [PATCH 20/21] Add note about no deployment_status events for inactive state (#3736) * Update events-that-trigger-workflows.md * fix typo * Apply suggestions from code review Co-authored-by: Sarah Edwards --- content/actions/reference/events-that-trigger-workflows.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/content/actions/reference/events-that-trigger-workflows.md b/content/actions/reference/events-that-trigger-workflows.md index e52cb74a8a..9693d877b4 100644 --- a/content/actions/reference/events-that-trigger-workflows.md +++ b/content/actions/reference/events-that-trigger-workflows.md @@ -271,6 +271,12 @@ on: deployment_status ``` +{% note %} + +**Note:** When a deployment status's state is set to `inactive`, a webhook event will not be created. + +{% endnote %} + #### `fork` Runs your workflow anytime when someone forks a repository, which triggers the `fork` event. For information about the REST API, see "[Create a fork](/rest/reference/repos#create-a-fork)." From 5cc4d0eb1ca87008d071bce2fb80a8b4f7d7e221 Mon Sep 17 00:00:00 2001 From: Janice Date: Fri, 19 Feb 2021 10:35:58 -0700 Subject: [PATCH 21/21] Revert "Update issue templates" --- .../ISSUE_TEMPLATE/improve-existing-docs.md | 33 ++++++++++++++++ .../ISSUE_TEMPLATE/improve-existing-docs.yaml | 39 ------------------- .github/ISSUE_TEMPLATE/improve-the-site.md | 33 ++++++++++++++++ .github/ISSUE_TEMPLATE/improve-the-site.yaml | 34 ---------------- 4 files changed, 66 insertions(+), 73 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/improve-existing-docs.md delete mode 100644 .github/ISSUE_TEMPLATE/improve-existing-docs.yaml create mode 100644 .github/ISSUE_TEMPLATE/improve-the-site.md delete mode 100644 .github/ISSUE_TEMPLATE/improve-the-site.yaml diff --git a/.github/ISSUE_TEMPLATE/improve-existing-docs.md b/.github/ISSUE_TEMPLATE/improve-existing-docs.md new file mode 100644 index 0000000000..26d822b9a4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/improve-existing-docs.md @@ -0,0 +1,33 @@ +--- +name: Improve existing docs +about: Make a suggestion to improve our existing documentation. +title: '' +labels: +- content +assignees: '' +--- + + + + +### What article on docs.github.com is affected? + + + +### What part(s) of the article would you like to see updated? + + + +### Additional information + + diff --git a/.github/ISSUE_TEMPLATE/improve-existing-docs.yaml b/.github/ISSUE_TEMPLATE/improve-existing-docs.yaml deleted file mode 100644 index 7203c0a930..0000000000 --- a/.github/ISSUE_TEMPLATE/improve-existing-docs.yaml +++ /dev/null @@ -1,39 +0,0 @@ ---- -name: Improve existing docs -about: Make a suggestion to improve our existing documentation. -labels: content -body: - - type: markdown - attributes: - value: | - HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD. - - For questions, ask in Discussions: https://github.com/github/docs/discussions - - type: checkboxes - attributes: - label: Contributing Guidelines - options: - - label: 'I agree to follow the [Code of Conduct](https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md)' - required: true - - label: 'I have read the [Contributing Guide](https://github.com/github/docs/blob/main/CONTRIBUTING.md)' - required: true - - label: 'There is not a similar issue that has been [already opened](https://github.com/github/docs/issues)' - required: true - - type: textarea - attributes: - label: Which article? - description: What article on [docs.github.com](https://docs.github.com) is affected? - placeholder: Add a link to the article you'd like to see updated - validations: - required: true - - type: textarea - attributes: - label: Desired Updates - description: What part(s) of the article would you like to see updated? - placeholder: Give as much detail as you can to help us understand the change you want to see. Why should the docs be changed? What use cases does it support? What is the expected outcome? - validations: - required: true - - type: textarea - attributes: - label: Additional Information - placeholder: Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/improve-the-site.md b/.github/ISSUE_TEMPLATE/improve-the-site.md new file mode 100644 index 0000000000..a79f8ed100 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/improve-the-site.md @@ -0,0 +1,33 @@ +--- +name: Improve the docs.github.com site +about: Make a suggestions or report a problem on the docs.github.com website. +title: '' +labels: engineering +assignees: '' +--- + + + + + +### What is the current behavior? + + + +### What changes are you suggesting? + + + +### Additional information + + diff --git a/.github/ISSUE_TEMPLATE/improve-the-site.yaml b/.github/ISSUE_TEMPLATE/improve-the-site.yaml deleted file mode 100644 index a811407870..0000000000 --- a/.github/ISSUE_TEMPLATE/improve-the-site.yaml +++ /dev/null @@ -1,34 +0,0 @@ ---- -name: Suggest ideas and updates for the Docs website -about: Make a suggestions or report a problem on the docs.github.com website. -labels: engineering -body: - - type: markdown - attributes: - value: | - HUBBERS BEWARE! Please confirm you're on the github/docs-internal repo and not the github/docs repo before proceeding, unless you want to make your work public to the entire internet. The github/docs repo is open source and public to the entire internet. - - For questions, ask in Discussions: https://github.com/github/docs/discussions - - type: checkboxes - attributes: - label: Contributing Guidelines - options: - - label: 'I agree to follow the [Code of Conduct](https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md)' - required: true - - label: 'I have read the [Contributing Guide](https://github.com/github/docs/blob/main/CONTRIBUTING.md)' - required: true - - label: 'There is not a similar issue that has been [already opened](https://github.com/github/docs/issues)' - required: true - - type: textarea - attributes: - label: Suggestion - description: What changes are you suggesting? - placeholder: Explain, in writing, with as much detail as possible, what changes you're suggesting and why. Provide supporting information using screenshots and URLs where possible, to help us understand your suggested changes. - validations: - required: true - - type: textarea - attributes: - label: Additional Information - placeholder: Any additional information, configuration, or data that might be necessary to reproduce the issue. - validations: - required: true