Add pointer to qiskit/documentation issues (Qiskit#1260)

* add pointer to qiskit/documentation issues * Update .github/ISSUE_TEMPLATE/config.yml Co-authored-by: Eric Arellano <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Eric Arellano <[email protected]> --------- Co-authored-by: Kevin Tian <[email protected]> Co-authored-by: Eric Arellano <[email protected]>
jyu00 · Dec 5, 2023 · 40b3076 · 40b3076
1 parent e9faa57
commit 40b3076
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Non-API docs issues
+    url: https://github.com/Qiskit/documentation/issues/new/choose
+    about: Open an issue about documentation in the Start, Build, Transpile, Verify, Run, or Migration guides sections of docs.quantum.ibm.com (non-API documentation)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -13,6 +13,10 @@ https://qiskit.org/documentation/contributing_to_qiskit.html
 In addition to the general guidelines there are specific details for
 contributing to qiskit-ibm-runtime, these are documented below.
 
+### Open an issue
+
+* For documentation issues relating to pages in the Start, Build, Transpile, Verify, Run, and Migration guides sections of https://docs.quantum.ibm.com, please open an issue in the [Qiskit/documentation repo](https://github.com/Qiskit/documentation/issues/new/choose) rather than the Qiskit/qiskit-ibm-runtime repo. In other words, any page that DOES NOT have `/api/` in the url should be addressed in the Qiskit/documentation repo. (Exception: the Migration guide urls contain `/api/` but are managed in the Qiskit/documentation repo.)
+* For issues relating to API reference pages (any page that contains /api/ in the url), please open an issue in the repo specific to that API reference.
 
 ### Pull request checklist