docs: add sdl multi-file format docs #938
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for SDL multi-file format in Bytebase's GitOps state-based workflow, explaining how to export and organize database schema files.
Key Changes:
- Added detailed instructions for exporting schema from Bytebase UI with multi-file format option
- Documented the complete multi-file directory structure and organization rules
- Expanded examples to show individual files for tables, views, functions, and sequences
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Getting Started | ||
|
|
||
| When starting with state-based workflow: | ||
| You don't need to write SDL files from scratch. Bytebase can export your existing database schema in the multi-file format, ready to use. |
There was a problem hiding this comment.
This is a requirement for now, instead of suggestion. We can emphasize schema export
|
|
||
|  | ||
|
|
||
| ### Quick Start Workflow |
There was a problem hiding this comment.
The quick start section seems to serve as an overview here, and docs for each individual steps should each be another section following this quick start (export, extract, review, commit, etc) . This will match the order the reader read this doc and match their expectation.
So maybe we should move this "Quick Start Workflow" section to be the first subsection under "Getting Started".
(But current document structure does not follow previous overview, I will enhance the document for the other sections.)
One other question: the "Review" section here may introduce confusion. If it means the initiator should review, then it's a bit redundant, and it may also collide with the SQL Review Ops/Action after initiator pushes the commit.
|
|
||
| ### What Gets Exported | ||
|
|
||
| The multi-file export includes: |
There was a problem hiding this comment.
It would be helpful to list the objects that will not be exported to files to let the user know, what objects are their responsibilities to be included.
close BYT-5117