Skip to content
This repository has been archived by the owner on Aug 19, 2023. It is now read-only.

Remove Aer and IBMQ provider from the sidebar #1643

Closed
1ucian0 opened this issue Dec 9, 2022 · 6 comments · Fixed by #1788
Closed

Remove Aer and IBMQ provider from the sidebar #1643

1ucian0 opened this issue Dec 9, 2022 · 6 comments · Fixed by #1788
Labels
documentation Something is not clear or error in description on hold Can not fix yet

Comments

@1ucian0
Copy link
Member

1ucian0 commented Dec 9, 2022

Currently, the side bar includes Qiskit Aer and Qiskit IBM Quantum Provider as part of the sidebar.

sidebar

As the metapackage deprecated the inclusion of these modules (and will be removed mid-2023) I think is time to remove them from the sidebar.

Does existing documentation need to be updated with new content?

  • Which files need to be updated?

docs/index.rst

  • What content needs to be updated or replaced? (You can copy and paste)
  API Reference <apidoc/terra>
  circuit_library
- aer
- ibmq-provider
  release_notes
  configuration
  • What new content needs to be added?

None.
@1ucian0 1ucian0 added the documentation Something is not clear or error in description label Dec 9, 2022
@jade-emperror
Copy link

giving it a shot. My first Contribution.

@jade-emperror
Copy link

@1ucian0 i can see AER and ibmq-provider is moved to Other Api Reference section recently. do we have to remove them from Other API Reference section ?

@HuangJunye
Copy link
Contributor

HuangJunye commented Feb 21, 2023 •
edited
Loading

@jade-emperror Thanks for proposing to help. We need to wait for qiskit-aer to have its own documentation (which should happen in Feb) and for qiskit-ibmq-provider we need to keep it on the sidebar until it’s archived (targeted in July). The PR itself is relatively simple but it requires coordination with other maintainers so I think it's not very suitable for external contributions.

How would you feel about instead looking for some other issues to contribute? You can look for the good first issues label in qiskit repos, for example, qiskit-terra: https://github.com/Qiskit/qiskit-terra/contribute. We'd love help with any of those!

@HuangJunye HuangJunye added the on hold Can not fix yet label Feb 21, 2023
@jade-emperror
Copy link

@HuangJunye Thanks for your response. i will look on good first issues on other qiskit repos.

@Eric-Arellano
Copy link
Collaborator

@1ucian0 is this no longer on hold, now that both projects have their own docs?

@1ucian0
Copy link
Member Author

1ucian0 commented May 17, 2023 •
edited
Loading

Both projects are still part of the current stable release (Qiskit 0.43). That is true until July. Let's remove them then.

@jakelishman jakelishman mentioned this issue Aug 4, 2023
Merged
@mergify mergify bot closed this as completed in #1788 Aug 4, 2023
mergify bot pushed a commit that referenced this issue Aug 4, 2023
@jakelishman
Remove metapackage-specific parts of documentation (#1788)
dfcb2f4 
### Summary

This removes many sections of the documentation that refer to the
metapackage as a whole, the elements of the metapackage, or refer to
Terra as Terra. This is intended to be in line with the new branding
decisions around the Qiskit project.

With the current community management structure still a little up in the
air, we are (at least temporarily) removing the repository-decision
flowchart from the documentation, since this documentation will
primarily be for Qiskit Terra. The contributor flowchart, or something
similar, may end up on the landing pages of the Ecosystem documentation,
or another community hub.

<!--
⚠️ If you do not respect this template, your pull request will be
closed.
⚠️ Your pull request title should be short detailed and understandable
for all.
⚠️ Also, please add it in the CHANGELOG file under Unreleased section.
⚠️ If your pull request fixes an open issue, please link to the issue.

✅ I have added the tests to cover my changes.
✅ I have updated the documentation accordingly.
✅ I have read the CONTRIBUTING document.
-->


### Details and comments

I've left references to "Terra" in place, because those should still
logically be removed as part of the general migration in naming within
the Terra repository. I've also left the build processes in place that
`git clone` Terra and the tutorials; we need those to continue having a
working docs build in this repo. They'll get modified as these files get
merge to Terra as well, but they need to stay alive here.

One of the notable removals is the API docs links to Aer and IBMQ from
the main page, since as of the deployed metapackage version (0.44),
those are no longer part of the metapackage.

Fix #1787.
Fix #1778 - mostly; the version logic is _way_ stripped down, and will
now automatically work on Terra at least as much as we need when the
files are merged.
Fix #1667 
Fix #1643
jakelishman added a commit to jakelishman/qiskit-terra that referenced this issue Aug 11, 2023
@jakelishman
Remove metapackage-specific parts of documentation (Qiskit/qiskit-met…
a156e4d 
…apackage#1788)

This removes many sections of the documentation that refer to the
metapackage as a whole, the elements of the metapackage, or refer to
Terra as Terra. This is intended to be in line with the new branding
decisions around the Qiskit project.

With the current community management structure still a little up in the
air, we are (at least temporarily) removing the repository-decision
flowchart from the documentation, since this documentation will
primarily be for Qiskit Terra. The contributor flowchart, or something
similar, may end up on the landing pages of the Ecosystem documentation,
or another community hub.


I've left references to "Terra" in place, because those should still
logically be removed as part of the general migration in naming within
the Terra repository. I've also left the build processes in place that
`git clone` Terra and the tutorials; we need those to continue having a
working docs build in this repo. They'll get modified as these files get
merge to Terra as well, but they need to stay alive here.

One of the notable removals is the API docs links to Aer and IBMQ from
the main page, since as of the deployed metapackage version (0.44),
those are no longer part of the metapackage.

Fix Qiskit/qiskit-metapackage#1787.
Fix Qiskit/qiskit-metapackage#1778 - mostly; the version logic is _way_ stripped down, and will
now automatically work on Terra at least as much as we need when the
files are merged.
Fix Qiskit/qiskit-metapackage#1667 
Fix Qiskit/qiskit-metapackage#1643
SamD-1998 pushed a commit to SamD-1998/qiskit-terra that referenced this issue Sep 7, 2023
@jakelishman @SamD-1998
Remove metapackage-specific parts of documentation (Qiskit/qiskit-met…
6165d1b 
…apackage#1788)

This removes many sections of the documentation that refer to the
metapackage as a whole, the elements of the metapackage, or refer to
Terra as Terra. This is intended to be in line with the new branding
decisions around the Qiskit project.

With the current community management structure still a little up in the
air, we are (at least temporarily) removing the repository-decision
flowchart from the documentation, since this documentation will
primarily be for Qiskit Terra. The contributor flowchart, or something
similar, may end up on the landing pages of the Ecosystem documentation,
or another community hub.


I've left references to "Terra" in place, because those should still
logically be removed as part of the general migration in naming within
the Terra repository. I've also left the build processes in place that
`git clone` Terra and the tutorials; we need those to continue having a
working docs build in this repo. They'll get modified as these files get
merge to Terra as well, but they need to stay alive here.

One of the notable removals is the API docs links to Aer and IBMQ from
the main page, since as of the deployed metapackage version (0.44),
those are no longer part of the metapackage.

Fix Qiskit/qiskit-metapackage#1787.
Fix Qiskit/qiskit-metapackage#1778 - mostly; the version logic is _way_ stripped down, and will
now automatically work on Terra at least as much as we need when the
files are merged.
Fix Qiskit/qiskit-metapackage#1667 
Fix Qiskit/qiskit-metapackage#1643
Eric-Arellano pushed a commit to Qiskit/documentation that referenced this issue Oct 12, 2023
@jakelishman
Remove metapackage-specific parts of documentation (Qiskit/qiskit-met…
a83bb3f 
…apackage#1788)

This removes many sections of the documentation that refer to the
metapackage as a whole, the elements of the metapackage, or refer to
Terra as Terra. This is intended to be in line with the new branding
decisions around the Qiskit project.

With the current community management structure still a little up in the
air, we are (at least temporarily) removing the repository-decision
flowchart from the documentation, since this documentation will
primarily be for Qiskit Terra. The contributor flowchart, or something
similar, may end up on the landing pages of the Ecosystem documentation,
or another community hub.


I've left references to "Terra" in place, because those should still
logically be removed as part of the general migration in naming within
the Terra repository. I've also left the build processes in place that
`git clone` Terra and the tutorials; we need those to continue having a
working docs build in this repo. They'll get modified as these files get
merge to Terra as well, but they need to stay alive here.

One of the notable removals is the API docs links to Aer and IBMQ from
the main page, since as of the deployed metapackage version (0.44),
those are no longer part of the metapackage.

Fix Qiskit/qiskit-metapackage#1787.
Fix Qiskit/qiskit-metapackage#1778 - mostly; the version logic is _way_ stripped down, and will
now automatically work on Terra at least as much as we need when the
files are merged.
Fix Qiskit/qiskit-metapackage#1667 
Fix Qiskit/qiskit-metapackage#1643
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
documentation Something is not clear or error in description on hold Can not fix yet
Projects
No open projects
Qiskit Sphinx Theme
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Remove metapackage-specific parts of documentation jakelishman/qiskit
4 participants
@1ucian0 @HuangJunye @Eric-Arellano @jade-emperror