Skip to content

Commit e324a04

Browse files
adela-bytebasetianzhouCopilot
authored
docs: add cicd plan, remove changelist (#773)
* add new plan * Update mintlify/docs.json Co-authored-by: Copilot <[email protected]> --------- Co-authored-by: Tianzhou <[email protected]> Co-authored-by: Copilot <[email protected]>
1 parent f440481 commit e324a04

15 files changed

+49
-45
lines changed

mintlify/change-database/plan.mdx

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: Plan
3+
---
4+
5+
A **Plan** is the core component of Bytebase’s CI/CD pipeline. It defines a series of schema or data changes to be applied to one or more databases.
6+
7+
### 1. Create a New Plan
8+
In your project, go to **CI/CD** > **Plans** in the left menu and click **New Plan**.
9+
10+
![new-plan](/content/docs/change-database/plan/bb-new-plan.webp)
11+
12+
### 2. Choose the Change Type
13+
Select either **Schema Migration (DDL)** or **Data Migration (DML)**. After adding the first change, you can continue to add more.
14+
15+
![plan-change-type](/content/docs/change-database/plan/bb-plan-change-type.webp)
16+
17+
### 3. Select Target Databases
18+
Choose one or more databases where the changes will be applied. Click **Confirm** to proceed.
19+
20+
![plan-targets](/content/docs/change-database/plan/bb-plan-targets.webp)
21+
22+
### 4. Add Changes
23+
Fill in the SQL statement. You can add multiple changes to the same plan. Once done, click **Create**.
24+
25+
![plan-add-change](/content/docs/change-database/plan/bb-plan-add-change.webp)
26+
![plan-2-change](/content/docs/change-database/plan/bb-plan-2-change.webp)
27+
28+
### 5. Submit for Review
29+
The plan starts in a `draft` state. Click **Ready for Review** to submit it for approval.
30+
31+
![plan-draft](/content/docs/change-database/plan/bb-plan-draft.webp)
32+
33+
### 6. Approve and Roll Out
34+
Once approved, go to the **Rollout** section to begin deployment.
35+
36+
![plan-approval](/content/docs/change-database/plan/bb-plan-approval.webp)
37+
![plan-ready-rollout](/content/docs/change-database/plan/bb-plan-ready-rollout.webp)
38+
39+
### 7. Deploy to Environments
40+
First, deploy to the `Test` environment. If successful, proceed to deploy to `Prod`.
41+
42+
![plan-rollout-test](/content/docs/change-database/plan/bb-plan-rollout-test.webp)
43+
![plan-rollout-prod](/content/docs/change-database/plan/bb-plan-rollout-prod.webp)

mintlify/change-database/schema-editor.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,11 @@ feature_name: SCHEMA_EDITOR
99

1010
## Schema Editor Entry
1111

12-
Select a certain project and go to **Database** -> **Databases** in the left-side menu. Select _one_ of the databases and click **Edit Schema**.
12+
While creating a new plan within a project, go to **CI/CD** > **Plans** in the left menu, and click **New Plan**. Choose `Schema Migration` as the plan type and click **Next**. Select _one_ database and click **Next**. You will see the Schema Editor.
13+
14+
![new-plan-schema-editor](/content/docs/change-database/schema-editor/bb-new-plan-schema-editor.webp)
15+
16+
Alternatively, you can go to **Database** > **Databases** in the left menu, select _one_ database and click **Edit Schema**.
1317

1418
![](/content/docs/change-database/schema-editor/schema-editor-entry.webp)
1519

mintlify/changelist.mdx

Lines changed: 0 additions & 43 deletions
This file was deleted.
29.7 KB
Loading
61.6 KB
Loading
58.1 KB
Loading
60 KB
Loading
40.7 KB
Loading
61.9 KB
Loading
70.4 KB
Loading

0 commit comments

Comments
 (0)