-
Notifications
You must be signed in to change notification settings - Fork 81
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
Revamp options page #1499
Revamp options page #1499
Conversation
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
@arnaucasau or @frankharkins , I need to change the order of these files in the TOC in the entries.py page. Overview should be above error suppression. I assume you just move them around, but Eric said it's complicated so we should ask you. Could one of you please make whatever change is necessary? This is what it looks like now:
|
Yes, in this case, we only need to change the order of the entries. I changed it in af0b867 and as you can see in the following screenshots, we get the correct order in the left ToC and in the index of the |
Since we're planning on putting in options for Estimator V1, V2 and Sampler V1, V2, it seems like the best thing to do would be to move that table into this topic (and add 3 more like it), rather than duplicating it. Thoughts? Another question - in the current table, we have a description and code example too. I feel like that will get really long but I don't want to lose that information. I'll think about a solution. |
Thanks for contributing to Qiskit documentation! Before your PR can be merged, it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. Thanks! 🙌 One or more of the following people are relevant to this code:
|
…entation into revamp-options-page
This reverts commit e2f98a8.
follow-up here: #1723 |
Prep for Qiskit#1499. * `/configure-runtime-compilation` will become `/configure-error-suppression`. * `/advanced-runtime-options` is being deleted and replaced with `/runtime-options-overview`, which isn't necessarily the same content. Still, it costs us nothing to do a redirect; it avoids a 404 for users and keeps our SEO we've built up for the page. I didn't update the page titles yet, which will be done in Qiskit#1499. We only need to get the URLs right here because those are hard to change.
Closes Qiskit#1416 Closes Qiskit#1453 Closes Qiskit#1247 Closes Qiskit#1529 Comment from Blake: the discoverability of the detailed Sampler and Estimator options is very poor. i.e. a user can only find these by navigating the Qiskit Runtime IBM Client API docs. Can we add links to [SamplerOptions](https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions) and [EstimatorOptions](https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) to the [Get started with primitives](https://docs.quantum.ibm.com/guides/get-started-with-primitives) page? --------- Co-authored-by: Arnau Casau <[email protected]> Co-authored-by: Ian Hincks <[email protected]> Co-authored-by: Jessie Yu <[email protected]>
This reverts commit 7d28ff4. The PR was merged accidentally due to a misunderstanding about PR previews. It's not yet ready to go live.
Closes #1416 Closes #1453 Closes #1247 Closes #1529 This reverts commit 5f45f0f. Accidentally closed #1499 --------- Co-authored-by: Arnau Casau <[email protected]> Co-authored-by: Ian Hincks <[email protected]> Co-authored-by: Jessie Yu <[email protected]> Co-authored-by: Rebecca Dimock <[email protected]> Co-authored-by: Rebecca Dimock <[email protected]> Co-authored-by: abbycross <[email protected]>
Closes #1416
Closes #1453
Closes #1247
Closes #1529
Comment from Blake: the discoverability of the detailed Sampler and Estimator options is very poor. i.e. a user can only find these by navigating the Qiskit Runtime IBM Client API docs. Can we add links to SamplerOptions and EstimatorOptions to the Get started with primitives page?