From d1622a10c2e15216c6cdf4965bbfb69cdd59b42c Mon Sep 17 00:00:00 2001 From: ABBY CROSS Date: Tue, 5 Dec 2023 15:00:10 -0500 Subject: [PATCH 1/3] add pointer to qiskit/documentation issues --- .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..7af0b931c --- /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 (non-API documentation) \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 87e485a6b..22a62d84f 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, 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 From c52cfbec63fcc2d829fc7f6c3753bdf8ea14175b Mon Sep 17 00:00:00 2001 From: Kevin Tian Date: Tue, 5 Dec 2023 15:37:58 -0500 Subject: [PATCH 2/3] Update .github/ISSUE_TEMPLATE/config.yml Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> --- .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 7af0b931c..f94ee26f4 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -2,4 +2,4 @@ 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 (non-API documentation) \ No newline at end of file + 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 From eb7492e492ca8cd634dc0964a86020e017125877 Mon Sep 17 00:00:00 2001 From: Kevin Tian Date: Tue, 5 Dec 2023 15:38:04 -0500 Subject: [PATCH 3/3] Update CONTRIBUTING.md Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 22a62d84f..4f82e6712 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,7 +15,7 @@ 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, 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 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