Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add pointer to qiskit/documentation issues #1260

Merged
merged 3 commits into from
Dec 5, 2023
+9 −0
Merged

Add pointer to qiskit/documentation issues #1260

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d1622a1
add pointer to qiskit/documentation issues
abbycross Dec 5, 2023
c52cfbe
Update .github/ISSUE_TEMPLATE/config.yml
kt474 Dec 5, 2023
eb7492e
Update CONTRIBUTING.md
kt474 Dec 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
kt474 marked this conversation as resolved.
Show resolved Hide resolved
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
abbycross marked this conversation as resolved.
Show resolved Hide resolved

* 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.)
kt474 marked this conversation as resolved.
Show resolved Hide resolved
* 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

Expand Down
Loading