From 80ff99c61027a925c10f34dc87e9d2b74618465f Mon Sep 17 00:00:00 2001 From: "Henry H. Andrews" Date: Tue, 30 Jan 2024 16:58:16 -0800 Subject: [PATCH 1/3] Provide a more direct set of issue routing links We want to send people asking questions (as opposed to reporting issues) or asking about tools or additional documentation to the right places. The previous links mostly sent people to other docs rather than to places where they could get questions answered or report other kinds of issues. --- .github/ISSUE_TEMPLATE/config.yml | 25 +++++++++++-------------- 1 file changed, 11 insertions(+), 14 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index c558164caf..4900e6dc01 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,17 +1,14 @@ blank_issues_enabled: true contact_links: - - name: OpenAPI Specification - url: https://spec.openapis.org/oas/latest.html - about: View the latest version of the specification - - name: Getting started documentation - url: https://learn.openapis.org - about: Learn about the OpenAPI Specification - - name: OpenAPI Tooling - url: https://tools.openapis.org - about: Open-source and commercial tools for OpenAPI - - name: OpenAPI Initiative Registry - url: https://spec.openapis.org/registry/index.html - about: Registry of formats, extension namespaces etc. - - name: OpenAPI Initiative Slack + - name: Have a question about using OpenAPI? url: https://communityinviter.com/apps/open-api/openapi - about: Join our online community. + about: Ask us on our Slack! + - name: Have a question bout OpenAPI Tooling? + url: https://tools.openapis.org/ + about: Please ask your tooling vendor! + - name: Want to add to our list of OpenAPI Tools? + url: https://github.com/OAI/Tooling/issues/new/choose + about: Open an issue on our tooling site! + - name: Want to suggest more documentation and examples? + url: https://github.com/OAI/learn.openapis.org/issues/new + about: Open an issue on our learning site! From 9b3900777e39d04952f9daf714eaaf4ea958dec0 Mon Sep 17 00:00:00 2001 From: Henry Andrews Date: Fri, 19 Apr 2024 09:39:40 -0700 Subject: [PATCH 2/3] Fix typo (review feedback- thanks!) Co-authored-by: Ralf Handl --- .github/ISSUE_TEMPLATE/config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 4900e6dc01..9b92a2f278 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -3,7 +3,7 @@ contact_links: - name: Have a question about using OpenAPI? url: https://communityinviter.com/apps/open-api/openapi about: Ask us on our Slack! - - name: Have a question bout OpenAPI Tooling? + - name: Have a question about OpenAPI Tooling? url: https://tools.openapis.org/ about: Please ask your tooling vendor! - name: Want to add to our list of OpenAPI Tools? From 43ee251c50d6aeec3393ada655bc42d85cc99afb Mon Sep 17 00:00:00 2001 From: "Henry H. Andrews" Date: Tue, 23 Apr 2024 16:00:09 -0700 Subject: [PATCH 3/3] Add links for this repository, turn off "blank" This adds links for things we actually want people to do in this repository. It directs enhancement requests to discussions rather than issues, mirroring what we're doing for the sig-moonwalk repo. This is done in the config file rather than with issue templates because GitHub forces issue templates to display at the top of the list, and the whole point of this configuration is to route people to other repositories for certain things. --- .github/ISSUE_TEMPLATE/config.yml | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 9b92a2f278..db8d5d8436 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,4 +1,9 @@ -blank_issues_enabled: true +blank_issues_enabled: false + +# The local issue filing links are included in "contact_links" because +# GitHub's regular issue template mechanism forces the local issue +# links to be first in the list, when we want them to be last so +# visitors can be routed to other repos when appropriate. contact_links: - name: Have a question about using OpenAPI? url: https://communityinviter.com/apps/open-api/openapi @@ -7,8 +12,17 @@ contact_links: url: https://tools.openapis.org/ about: Please ask your tooling vendor! - name: Want to add to our list of OpenAPI Tools? - url: https://github.com/OAI/Tooling/issues/new/choose - about: Open an issue on our tooling site! - - name: Want to suggest more documentation and examples? + url: https://tools.openapis.org/ + about: Please take a look at our tooling site's instructions! + - name: Want to suggest more how-to documentation and examples? url: https://github.com/OAI/learn.openapis.org/issues/new - about: Open an issue on our learning site! + about: Please open an issue on our learning site! + - name: Want to add to the registries at spec.openapis.org/registry ? + url: https://github.com/OAI/OpenAPI-Specification/issues/new + about: Please open an issue in this repository! + - name: Want to report an error in the specification? + url: https://github.com/OAI/OpenAPI-Specification/issues/new + about: Please open an issue in this repository! + - name: Want to request a new feature in the specification? + url: https://github.com/OAI/OpenAPI-Specification/discussions/new?category=enhancements + about: Please start a discussion in this repository!