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

Revamp options page #1499

Merged
merged 69 commits into from
Jul 16, 2024
Merged

Revamp options page #1499

merged 69 commits into from
Jul 16, 2024

Conversation

beckykd
Copy link
Collaborator

@beckykd beckykd commented Jun 5, 2024

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?

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@beckykd
Copy link
Collaborator Author

beckykd commented Jun 6, 2024

@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:

    children=(
        Entry(
            "Configure error suppression",
            slug="/configure-error-suppression",
            from_file="run/configure-error-suppression.mdx",
        ),
        Entry(
            "Configure runtime error mitigation",
            slug="/configure-error-mitigation",
            from_file="run/configure-error-mitigation.mdx",
        ),
        Entry(
            "Qiskit Runtime options overview",
            slug="/runtime-options-overview",
            from_file="run/runtime-options-overview.mdx",

@arnaucasau
Copy link
Collaborator

arnaucasau commented Jun 6, 2024

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 execute-on-hardware page. Let me know if I can help with something else :)

Captura desde 2024-06-06 19-57-04

Captura desde 2024-06-06 19-57-17

@javabster
Copy link
Collaborator

I got some feedback from the enablement team that they have been using this table in some of their workshops with users and it has been well received, do you think there is a way to incorporate this table (or something similar) into the options page?
Screenshot 2024-06-07 at 2 30 03 AM

@beckykd
Copy link
Collaborator Author

beckykd commented Jun 10, 2024

do you think there is a way to incorporate this table (or something similar) into the options page?

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.

@beckykd beckykd marked this pull request as ready for review July 2, 2024 20:37
@qiskit-bot
Copy link
Contributor

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:

@beckykd beckykd added this pull request to the merge queue Jul 16, 2024
Merged via the queue into main with commit e2f98a8 Jul 16, 2024
3 checks passed
@beckykd beckykd deleted the revamp-options-page branch July 16, 2024 19:22
Eric-Arellano added a commit that referenced this pull request Jul 16, 2024
github-merge-queue bot pushed a commit that referenced this pull request Jul 16, 2024
This reverts commit e2f98a8.

The PR was merged accidentally due to a misunderstanding about PR
previews. It's not yet ready to go live.
@beckykd
Copy link
Collaborator Author

beckykd commented Jul 16, 2024

follow-up here: #1723

frankharkins pushed a commit to frankharkins/documentation that referenced this pull request Jul 22, 2024
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.
frankharkins pushed a commit to frankharkins/documentation that referenced this pull request Jul 22, 2024
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]>
frankharkins pushed a commit to frankharkins/documentation that referenced this pull request Jul 22, 2024
This reverts commit 7d28ff4.

The PR was merged accidentally due to a misunderstanding about PR
previews. It's not yet ready to go live.
github-merge-queue bot pushed a commit that referenced this pull request Jul 31, 2024
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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
7 participants