Skip to content

Commit

Permalink
Add script to migrate to new guides/ structure (Qiskit#1294)
Browse files Browse the repository at this point in the history
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 <[email protected]>
Co-authored-by: Arnau Casau <[email protected]>
  • Loading branch information
3 people authored May 30, 2024
1 parent 6b7cd5b commit fb71aba
Show file tree
Hide file tree
Showing 5 changed files with 976 additions and 0 deletions.
Loading

0 comments on commit fb71aba

Please sign in to comment.