You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In #1294, each of the 4 patterns pages links out to the rest of the docs app. It provides an alternative organization than the tools-based approach.
We are going to manually maintain both guides/_toc.json and those 4 index pages. There are a few edge cases that would be too complex for us to generate the index files in a clear way. It's best to let humans decide what goes where.
However, we want an automated check to ensure that every page shows up both in the Tools folders & in the Workflow index pages. Likewise, a page should never show up >1 time in the _toc.json or the index pages. The check should not care what TOC section/workflow index the specific page shows up in; we only need to validate that it shows up exactly once in both places.
This code is probably useful for how to parse the index pages:
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>
In #1294, each of the 4 patterns pages links out to the rest of the docs app. It provides an alternative organization than the tools-based approach.
We are going to manually maintain both
guides/_toc.json
and those 4 index pages. There are a few edge cases that would be too complex for us to generate the index files in a clear way. It's best to let humans decide what goes where.However, we want an automated check to ensure that every page shows up both in the Tools folders & in the Workflow index pages. Likewise, a page should never show up >1 time in the
_toc.json
or the index pages. The check should not care what TOC section/workflow index the specific page shows up in; we only need to validate that it shows up exactly once in both places.This code is probably useful for how to parse the index pages:
documentation/scripts/lib/api/TocGrouping.test.ts
Line 80 in 2974d28
Note that the index pages may have sublists, like
*
with indentation.We probably need an allowlist mechanism. Right now, Qiskit Serverless only shows up in the Tools and not Workflow index pages.
The text was updated successfully, but these errors were encountered: