-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
Refer to IBM docs #10640
Refer to IBM docs #10640
Conversation
Pull Request Test Coverage Report for Build 5903102057
💛 - Coveralls |
One or more of the the following people are requested to review this:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A bit minor, but as I understand it, much of this is directly lifted from Abby's PR Qiskit/qiskit-metapackage#1791 - it might be nice to make sure Abby's credited at least as a co-author on the PR.
"theme_announcement": "🎉 Qiskit is getting a new documentation experience on IBM Quantum!", | ||
"announcement_url": "https://docs.quantum-computing.ibm.com/", | ||
"announcement_url_text": "Check it out", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This feels like a slightly weird coupling between the theme and the repository, but not a huge deal.
Minor: the split of "namespacing" one variable with theme_
but not the others is a bit odd to me.
(Personally, I'd prefer we namespace everything Qiskit-specific with a qiskit_
prefix, since we have to share the namespace with everything Sphinx-related, and reading the conf file, it's unclear to me now what's related to the theme and what's not, but that's a relatively minor issue and out of scope any way.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah I agree. Too late to change now that it's been released though.
Co-authored-by: Abby Mitchell <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As far as I'm concerned this is fine, but probably best to get a review from someone properly on the docs squad / involved in the 1XP discussions before merge.
We've internally shared screenshots with Jules and she approved :) |
Ah, @jakelishman @mtreinish I forgot to put stable-backport-potential when opening this. It would help the 1XP team a lot if this went out on stable docs, not only the dev docs. |
Either way, best have Abby sign off on the PR to keep the full spirit of the review process, since she'd suggested changes. |
And yeah, this is inherently stable for backport, so no trouble adding the label. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 🚀
* Refer to IBM docs * Review feedback * Use live links * Properly attribute code to Abby! Co-authored-by: Abby Mitchell <[email protected]> --------- Co-authored-by: Abby Mitchell <[email protected]> (cherry picked from commit 94820e6)
* Refer to IBM docs * Review feedback * Use live links * Properly attribute code to Abby! Co-authored-by: Abby Mitchell <[email protected]> --------- Co-authored-by: Abby Mitchell <[email protected]> (cherry picked from commit 94820e6) Co-authored-by: Eric Arellano <[email protected]>
Closes #10594.