-
Notifications
You must be signed in to change notification settings - Fork 132
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
Rename Folders #3182
Rename Folders #3182
Conversation
jameskerr
commented
Mar 7, 2025
- Rename Packages
- Rename zui-player to just player
- Rename packages
- Fix the readme
- Remove zed
- Remove zui from workflow
- Fix build workflow
- Fix workflows
I've noticed when I run
|
- [**zui-player**](packages/zui-player): the end-to-end testing framework for Zui | ||
- [**superdb-types**](packages/superdb-types): the JavaScript library for the data types return from a server. | ||
- [**superdb-node-client**](packages/superdb-node-client): the JavaScript library for [Node.js](https://nodejs.org/) | ||
- [**player**](packages/app-player): the end-to-end testing framework for the desktop app |
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.
While the top-line PR description mentioned "Rename zui-player to just player", I noticed that the directory name in this branch is currently app-player
. That was causing a link failure here in the README where it was pointing to just player
. Since tests all seem to be passing with the directory being app-player
I assume that's intentional so I made the change here in the link to satisfy the markdown link checker in CI.
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.
I pushed a couple commits to fix hyperlinks that were failing in the markdown link checker in CI. One failure that remains is the one in apps/superdb-desktop/docs/developer/README.md
to https://github.com/brimdata/zui/blob/main/apps/superdb-desktop/CONTRIBUTING.md
but that'll start working once this PR merges so I'm happy to merge in this state.
Speaking of docs, I also just took the liberty of disabling the "Deploy to Netlify" Actions Workflow in the https://github.com/brimdata/zui-docs-site repo. Much like we did with https://zed.brimdata.io/, I expect we'll want to freeze https://zui.brimdata.io/ in its current state to benefit the legacy users that are still relying on the GA releases for now. At some point soon we can get started on adding automation to start publishing the SuperDB Desktop docs in a section of https://superdb.org/docs, so that can be the home for new app docs.
Regarding my comment above about the yarn test
failures I've observed, I'm fine with merging this one and taking that up as a separate topic. This branch already touches so many files that it's difficult to work with in the GitHub UI.
It looks like those tests are running on the "build" files in the dist folder. They aren't supposed to be doing that. Let me see how to ignore those... |