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

Fix index pages for Runtime and Provider API docs #355

Merged
merged 1 commit into from
Nov 15, 2023

Conversation

Eric-Arellano
Copy link
Collaborator

Closes #339.

It wasn't intentional that we didn't have index.md files and instead used /runtime_service and /ibm_provider. It was only because that's what the original qiskit.org docs do, and I don't think we realized that was bad and we should fix it.

This PR does mean /runtime_service and /ibm_provider will now 404. I couldn't find any references to those pages outside of our own docs, so it didn't seem necessary to set up redirects. But I can if we think it's important.

Copy link
Member

@frankharkins frankharkins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Are you also updating the links in the nav bar?

Screenshot 2023-11-15 at 15 04 40

docs/api/qiskit-ibm-provider/_toc.json Show resolved Hide resolved
Copy link
Collaborator Author

@Eric-Arellano Eric-Arellano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes to updating the top nav bar and home page when syncing these docs to go live. We can't change that here. Good catch!

docs/api/qiskit-ibm-provider/_toc.json Show resolved Hide resolved
Copy link
Member

@frankharkins frankharkins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thanks!

@Eric-Arellano Eric-Arellano merged commit 0401585 into main Nov 15, 2023
3 checks passed
@Eric-Arellano Eric-Arellano deleted the EA/fix-api-docs-index branch November 15, 2023 15:31
frankharkins pushed a commit to frankharkins/documentation that referenced this pull request Jul 22, 2024
Closes Qiskit#339.

It wasn't intentional that we didn't have `index.md` files and instead
used `/runtime_service` and `/ibm_provider`. It was only because that's
what the original qiskit.org docs do, and I don't think we realized that
was bad and we should fix it.

This PR does mean `/runtime_service` and `/ibm_provider` will now 404. I
couldn't find any references to those pages outside of our own docs, so
it didn't seem necessary to set up redirects. But I can if we think it's
important.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Fix index pages for Provider and Runtime
2 participants