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.

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

Set up issue templates in qiskit and qiskit-ibm-runtime to redirect here #48

Closed
Eric-Arellano opened this issue Sep 8, 2023 · 5 comments
Assignees

Comments

@Eric-Arellano
Copy link
Collaborator

@abbycross heard about GitHub allowing you to have an issue template that redirects you to another repository. We'd add this to qiskit and qiskit-ibm-runtime to make it clear to people that docs problems should go to this repo.

I think that might be something like this? https://github.com/orgs/community/discussions/50220

This is on hold until we remove qiskit.org/documentation. Until then, it is legitimate to have docs issues in qiskit because its docs files are different than the ones here.

@Eric-Arellano
Copy link
Collaborator Author

Eric-Arellano commented Oct 13, 2023

Closed by @abbycross in #122. Thanks! Update: nope, I read too quickly.

@Eric-Arellano Eric-Arellano reopened this Oct 13, 2023
@Eric-Arellano Eric-Arellano moved this from Done to Todo in Docs Planning Nov 28, 2023
@abbycross
Copy link
Collaborator

Is this still needed? The API docs are still generated from qiskit/qiskit and /qiskit-ibm-runtime, so any changes to those docs would need to be reported to those repos.

I'm trying to recall if we thought we needed to clarify in those repos that non-API docs issues should be opened here 🤣 Anyone remember @Eric-Arellano @javabster @beckykd ?

@javabster
Copy link
Collaborator

I think this is meant to cover non-api reference docs. So if a user wants to report an issue in e.g. the run section they shouldn't go to the qiskit repo to open that issue, instead they should go to this repo. We just need to make it clear in the template that they shouldnt go here for api reference issues, only docs issues. I think as part of this issue it would also be good to update their contributing guide pages as well 🤔

@abbycross
Copy link
Collaborator

PR for qiskit-ibm-runtime here

PR for qiskit/qiskit here

@abbycross abbycross moved this from Todo to In Progress in Docs Planning Dec 5, 2023
@abbycross abbycross self-assigned this Dec 5, 2023
@Eric-Arellano
Copy link
Collaborator Author

Both have been merged. Thanks @abbycross !

@github-project-automation github-project-automation bot moved this from In Progress to Done in Docs Planning Dec 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

No branches or pull requests

3 participants