-
Notifications
You must be signed in to change notification settings - Fork 90
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
Add anchors to show/hide sections in install page #589
Conversation
Ignore my first commit -- it's no longer the direction we're going in!! |
Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>
Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>
Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>
Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
Update: @javabster suggested trying
within the One option is to include a header within the show/hide content itself, which would show the chain icon, AND this means the header would show up on the right nav (if it's h2 or h3), but then we would have a duplicated line situation like this: Another option is to create the header right within the summary tags, which would work great if the chain icon wasn't superimposed with the caret to click on!! Thoughts or reasonable workarounds appreciated!... I have scoured the internet but perhaps am not using the right search terms... |
Had an offline conversation with @javabster and we determined that the best way to move forward is to return to the original formatting of this content and create custom anchor links for the show/hide sections. In the future we hope to have a better component for the show-hide sections so that we can more flexibly link to them. |
One last comment: while this functionality works, the links may appear only to jump to the Qiskit versioning section, because the show/hide section is so close to the end of the page. 🤷 |
Final commit wasn't pushed to #589 ! --------- Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com> Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
EDIT: Adding custom anchor tags to the show/hide sections in the "Qiskit versioning" section. Once this is merged, direct links to the show-hide sections will be: https://docs.quantum.ibm.com/start/install#release-schedule https://docs.quantum.ibm.com/start/install#upgrade-strategy https://docs.quantum.ibm.com/start/install#pre-releases https://docs.quantum.ibm.com/start/install#post-releases --------------------------- (Original proposal below, for historical purposes; we are no longer separating out the versioning section to a new page.) In discussions with @mtreinish, the proposal is to separate out the versioning section (currently at the end of the start/install page) into a new page, for the following reasons: - it really isn't directly install-related - it allows us to remove the show/hide features for that content, which makes it easier to link to and find We may also want to remove the show/hide features for the OS support tiers, but leave them in the current install page, since they are install-related. Topics to discuss: - [ ] What to put in Next steps section? Currently using the same as what is on the Install pg as a placeholder. - [ ] Title at the moment is just Qiskit versioning (since that's the only thing in the new page); are we good with this? - [ ] I put the new page after the "Advanced setup" section in the toc. Should it be elsewhere? cc: @mtreinish @Eric-Arellano --------- Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com> Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
Final commit wasn't pushed to Qiskit#589 ! --------- Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com> Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
EDIT: Adding custom anchor tags to the show/hide sections in the "Qiskit versioning" section.
Once this is merged, direct links to the show-hide sections will be:
https://docs.quantum.ibm.com/start/install#release-schedule
https://docs.quantum.ibm.com/start/install#upgrade-strategy
https://docs.quantum.ibm.com/start/install#pre-releases
https://docs.quantum.ibm.com/start/install#post-releases
(Original proposal below, for historical purposes; we are no longer separating out the versioning section to a new page.)
In discussions with @mtreinish, the proposal is to separate out the versioning section (currently at the end of the start/install page) into a new page, for the following reasons:
We may also want to remove the show/hide features for the OS support tiers, but leave them in the current install page, since they are install-related.
Topics to discuss:
cc: @mtreinish @Eric-Arellano