feat: CMS - Switch to copying files instead of hard-linking #541
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously we used a hard-link to include files in astro so that mkdocs and starlight would continue to work together - however, this is now slowing down progress in generating api documentation (Python & TypeScript). Switch to doing a straight copy to the directory.
Contributor
Documentation Preview ReadyYour documentation preview has been successfully deployed! Preview URL: https://d3ehv1nix5p99z.cloudfront.net/pr-cms-541/user-guide/quickstart/overview/ Updated at: 2026-02-11T19:30:17.233Z |
| const files: string[] = []; | ||
| const assetExtensions = [".png", ".jpg", ".jpeg", ".gif", ".svg", ".webp", ".ico", ".js", ".css"]; | ||
|
|
||
| async function walk(currentDir: string) { |
Contributor
There was a problem hiding this comment.
this function seems very similar to line 90, do we want to extract it?
Member
Author
There was a problem hiding this comment.
Not really; this script is basically just for converting the docs; once we migrate to the new CMS, we're throwing this away.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Note: This is targeting the
workstream/cms-migrationbranch.Previously we used a hard-link to include files in starlight/astro so that mkdocs and starlight would continue to work together - however, this is now slowing down progress in generating api documentation (Python & TypeScript). So switch to doing a straight copy to the directory.
Changes in this PR:
/docs->src/content/docswhich is where starlight needs them; previously we used a directory linkupdate-docs.tsto account for this; as noted before, this is a script that will be used to do the final migration and so the contents are not to be tightly reviewed unless you see something obvious. The final output is the more important part.Related Issues
#441
Type of Change
Checklist
mkdocs serveBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.