Patterns: update all non-API links to guides/ #1460
Assignees
Labels
Comments
This was referenced May 29, 2024
github-merge-queue bot
pushed a commit
that referenced
this issue
May 30, 2024
This is the first step in #1297. We're going to be making last-minute changes for the docs reorg, such as finalizing URLs at the last minute. So, it's useful to have a program that can immediately regenerate the entire migration for us at any time. This program will eventually generate two commits: 1. Move files to guides/ 2. Update non-API internal links, like `/run/my-page` to `/guides/my-page` Thanks to this script being checked in to version control beforehand, we will have less code to review in the final migration PR. This program is not going to be permanent. We decided in #1299 that we will not generate the Workflow index pages longterm, only in this initial PR. Instead, we'll add a validation check. So this program is only temporary while we work on the migration. ## Follow up improvements This PR is only the initial foundation of the migration program. Remaining tasks: * Finalize the page URLs * Finalize the page organization in the left ToC and Patterns Index pages * Finalize the content for the new pages * Delete the existing pages and save the change as a Git commit. * Get CI to be green when running the migration program, such as the link checker. * #1299 * #1460 --------- Co-authored-by: javabster <abby.s.mitchell@gmail.com> Co-authored-by: Arnau Casau <arnaucasau@gmail.com>
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this issue
Jul 22, 2024
This is the first step in Qiskit#1297. We're going to be making last-minute changes for the docs reorg, such as finalizing URLs at the last minute. So, it's useful to have a program that can immediately regenerate the entire migration for us at any time. This program will eventually generate two commits: 1. Move files to guides/ 2. Update non-API internal links, like `/run/my-page` to `/guides/my-page` Thanks to this script being checked in to version control beforehand, we will have less code to review in the final migration PR. This program is not going to be permanent. We decided in Qiskit#1299 that we will not generate the Workflow index pages longterm, only in this initial PR. Instead, we'll add a validation check. So this program is only temporary while we work on the migration. ## Follow up improvements This PR is only the initial foundation of the migration program. Remaining tasks: * Finalize the page URLs * Finalize the page organization in the left ToC and Patterns Index pages * Finalize the content for the new pages * Delete the existing pages and save the change as a Git commit. * Get CI to be green when running the migration program, such as the link checker. * Qiskit#1299 * Qiskit#1460 --------- Co-authored-by: javabster <abby.s.mitchell@gmail.com> Co-authored-by: Arnau Casau <arnaucasau@gmail.com>
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this issue
Jul 22, 2024
Closes Qiskit#1460 This PR adds a script to update all the non-API links to point to `guides/` taking into account that all the files will now be in the same folder, and there's no need to preserve the relative paths
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Part of #1294.
We need to update internal links to the new
guides/URLs. We should use that PR as the source of truth for what the redirects are.The updated links should be done in a single automated Git commit, made by the migration program. Although, we aren't ready at the moment with the rest of the changes for this Git commit idea. Instead, I recommend having a dedicated program with its own
main(), likeupdate_links.py. It won't do anything with Git - only update the URLs. That program can of course import the rest of the files inscripts/patterns-reorg, like computing the redirects.The text was updated successfully, but these errors were encountered: