From 40b3076ca3467ba2981d7ea1dcec5229537d2b33 Mon Sep 17 00:00:00 2001 From: abbycross Date: Tue, 5 Dec 2023 17:59:21 -0500 Subject: [PATCH] Add pointer to qiskit/documentation issues (#1260) * add pointer to qiskit/documentation issues * Update .github/ISSUE_TEMPLATE/config.yml Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> --------- Co-authored-by: Kevin Tian Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/config.yml | 5 +++++ CONTRIBUTING.md | 4 ++++ 2 files changed, 9 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..f94ee26f4 --- /dev/null +++ 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) \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 87e485a6b..4f82e6712 100644 --- 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