-
-
Notifications
You must be signed in to change notification settings - Fork 95
Add tool to regenerate .mdx files #1866
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add a README to the tool, and a changelog entry that describes what this tool does?
Also, this needs to be enabled in CI.
e6b3004
to
5cac181
Compare
36cd8f3
to
577670c
Compare
577670c
to
06fd867
Compare
06fd867
to
ca5b7e7
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just some smaller comments on the README.
The tool itself seems to work as expected. I tested this by using an older version of VAST to create a database, and then using this tool on the database before running a recent version of VAST. Everything started up as expected.
📔 Description
On a large DB, it can take a lot of time to regenerate the .mdx synopsis files on startup if the previous version somehow got corrupted or outdated. VAST never accesses these files during operation, so this can safely be done before restarting VAST to ensure minimal downtime. This tool provides just that functionality, ie. a way to bulk-update all
.mdx
files of a database that does not interfere with the running VAST process.📝 Checklist
🎯 Review Instructions