Skip to content

Commit 0e71869

Browse files
committed
docs: change tutorial section name to be consistent
1 parent f0908cc commit 0e71869

15 files changed

+48
-43
lines changed

mintlify/docs.json

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -136,10 +136,7 @@
136136
},
137137
{
138138
"group": "Appendix",
139-
"pages": [
140-
"sql-review/review-rules",
141-
"sql-review/error-codes"
142-
]
139+
"pages": ["sql-review/review-rules", "sql-review/error-codes"]
143140
}
144141
]
145142
},
@@ -252,9 +249,7 @@
252249
},
253250
{
254251
"group": "Infrastructure as Code",
255-
"pages": [
256-
"integrations/terraform/overview"
257-
]
252+
"pages": ["integrations/terraform/overview"]
258253
},
259254
{
260255
"group": "3rd Party",
@@ -272,7 +267,7 @@
272267
"tab": "Tutorials",
273268
"pages": [
274269
{
275-
"group": "Database CI/CD (GUI)",
270+
"group": "UI-Driven Workflow",
276271
"pages": [
277272
"tutorials/first-schema-change",
278273
"tutorials/deploy-schema-migration",
@@ -286,7 +281,7 @@
286281
]
287282
},
288283
{
289-
"group": "Database CI/CD (GitOps)",
284+
"group": "GitOps Workflow",
290285
"pages": [
291286
"tutorials/gitops-github-workflow",
292287
"tutorials/gitops-azure-devops-workflow",

mintlify/tutorials/batch-change-with-database-group.mdx

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ author: Adela
44
updated_at: 2025/08/11 18:00
55
tags: Tutorial
66
integrations: General
7-
category: 'Database CI/CD (GUI)'
7+
category: 'UI-Driven Workflow'
88
level: Intermediate
99
estimated_time: '20 mins'
1010
---
@@ -37,6 +37,7 @@ Bytebase simplifies deploying changes across multiple databases simultaneously.
3737
1. In the new project, navigate to **Database > Databases** and click **+ New DB**. Create `demo-test` on the Test instance. Click **Rollout** when the issue appears.
3838

3939
1. Similarly, create the following databases:
40+
4041
- `demo-prod-1` and `demo-prod-2` on `ProdAsia`
4142
- `demo-prod-3` and `demo-prod-4` on `ProdEU`
4243
- `demo-prod-5` and `demo-prod-6` on `ProdNA`
@@ -90,14 +91,14 @@ We need first to upgrade to Pro/Enterprise Plan to use Database Group.
9091
```
9192

9293
1. The **Overview** and **Rollout** tabs now show 3 production stages. Click **Run** in the ProdAsia stage to execute.
93-
94+
9495
![bb-overview-3-stages](/content/docs/tutorials/batch-change-with-database-group/bb-overview-3-stages.webp)
9596
![bb-rollout-3-stages](/content/docs/tutorials/batch-change-with-database-group/bb-rollout-3-stages.webp)
9697

9798
## Summary
9899

99-
You've learned how to:
100-
101-
- Group databases by environment for staged rollouts
102-
- Use Database Groups to target databases matching specific criteria
103-
- Execute batch changes across multiple databases efficiently
100+
You've learned how to:
101+
102+
- Group databases by environment for staged rollouts
103+
- Use Database Groups to target databases matching specific criteria
104+
- Execute batch changes across multiple databases efficiently

mintlify/tutorials/data-rollback.mdx

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ author: Adela
44
updated_at: 2025/08/11 16:15
55
tags: Tutorial
66
integrations: General
7-
category: 'Database CI/CD (GUI)'
7+
category: 'UI-Driven Workflow'
88
featured: true
99
level: Beginner
1010
estimated_time: '30 mins'
@@ -84,4 +84,9 @@ Bytebase stores backup data in a dedicated `bbdataarchive` schema (for PostgreSQ
8484

8585
For MySQL, SQL Server, and Oracle, Bytebase uses a separate `bbdataarchive` **database** rather than a schema to store backups. See the documentation below for details.
8686

87-
<Card title="Data Rollback Doc" icon="book" href="/change-database/rollback-data-changes/" horizontal />
87+
<Card
88+
title="Data Rollback Doc"
89+
icon="book"
90+
href="/change-database/rollback-data-changes/"
91+
horizontal
92+
/>

mintlify/tutorials/database-change-management-with-risk-adjusted-approval-flow.mdx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,13 @@ author: Adela
44
updated_at: 2023/06/01 16:15
55
tags: Tutorial
66
integrations: General
7-
category: 'Database CI/CD (GUI)'
7+
category: 'UI-Driven Workflow'
88
level: Intermediate
99
estimated_time: '15 mins'
1010
---
1111

1212
import TerminalDockerRunVolume from '/snippets/install/terminal-docker-run-volume.mdx';
1313

14-
1514
Bytebase provides a basic yet configurable rollout mechanism by default. This means that manual rollout is skipped for **Test** environments and required for **Prod** environments.
1615

1716
However, for more complicated enterprise-level cases, users may need different approval flows to handle database changes according to different potential risks. For example, DDL in Prod environments is considered high risk, while DML in Test environments is low risk. Additionally, users may need to involve roles other than **DBA/Developer/Project Leader**, such as **Testers**.
@@ -89,8 +88,8 @@ To learn the best practice, check out [Risks Best Practice](/tutorials/risks-bes
8988

9089
1. Either click **the related risk rules** or **CI/CD > Risks** on the left bar. Add two new rules
9190

92-
- Name: `DDL ALTER`; Risk Level: `High`; Type: `DDL`; Condition: `sql_type == 'ALTER_TABLE'`
93-
- Name: `DDL CREATE`; Risk Level: `Moderate`; Type: `DDL`; Condition: `sql_type == 'CREATE_TABLE'`
91+
- Name: `DDL ALTER`; Risk Level: `High`; Type: `DDL`; Condition: `sql_type == 'ALTER_TABLE'`
92+
- Name: `DDL CREATE`; Risk Level: `Moderate`; Type: `DDL`; Condition: `sql_type == 'CREATE_TABLE'`
9493

9594
![bb-risks](/content/docs/tutorials/database-change-management-with-risk-adjusted-approval-flow/bb-risks.webp)
9695

mintlify/tutorials/deploy-schema-migration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ author: Adela
44
updated_at: 2025/08/08 12:00
55
tags: Tutorial
66
integrations: General
7-
category: 'Database CI/CD (GUI)'
7+
category: 'UI-Driven Workflow'
88
level: Beginner
99
estimated_time: '30 mins'
1010
featured: true

mintlify/tutorials/first-schema-change.mdx

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ author: Adela
44
tags: Tutorial
55
updated_at: 2024/10/10 20:00
66
integrations: General
7-
category: 'Database CI/CD (GUI)'
7+
category: 'UI-Driven Workflow'
88
level: Beginner
99
estimated_time: '5 mins'
1010
featured: true
@@ -36,17 +36,19 @@ In this tutorial, you'll use the default sample databases to get familiar with t
3636
![plan-change-type](/content/docs/change-database/plan/bb-plan-change-type.webp)
3737

3838
1. Select the databases where changes will be applied:
39-
- `hr_test` on `Test Sample instance`
39+
40+
- `hr_test` on `Test Sample instance`
4041
- `hr_prod` on `Prod Sample instance`
41-
42+
4243
Click **Confirm** to proceed.
4344
![plan-targets](/content/docs/change-database/plan/bb-plan-targets.webp)
4445

4546
1. Add the SQL statement:
47+
4648
```sql
4749
ALTER TABLE public.employee ADD COLUMN IF NOT EXISTS nickname TEXT;
4850
```
49-
51+
5052
Click **Create** to create the plan.
5153

5254
1. The plan will be in `Draft` status. You may see SQL review warnings, especially for the production environment. This is because Bytebase automatically runs configured checks.
@@ -55,10 +57,11 @@ In this tutorial, you'll use the default sample databases to get familiar with t
5557
## Step 4 - Review and Approve
5658

5759
1. To fix the SQL review warning, edit the SQL to add `NOT NULL DEFAULT ''`:
60+
5861
```sql
5962
ALTER TABLE public.employee ADD COLUMN IF NOT EXISTS nickname TEXT NOT NULL DEFAULT '';
6063
```
61-
64+
6265
Click **Save** to update the plan. The checks will run again and should pass.
6366

6467
1. Click **Ready for Review** and then **Confirm** to submit the plan for approval.

mintlify/tutorials/gitops-azure-devops-workflow.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ author: Adela
44
updated_at: 2025/03/28 18:00
55
tags: Tutorial
66
integrations: 'API, Azure DevOps'
7-
category: 'Database CI/CD (GitOps)'
7+
category: 'GitOps Workflow'
88
level: Advanced
99
estimated_time: '40 mins'
1010
---

mintlify/tutorials/gitops-bitbucket-workflow.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ author: Adela
44
updated_at: 2025/05/14 18:00
55
tags: Tutorial
66
integrations: Bitbucket
7-
category: 'Database CI/CD (GitOps)'
7+
category: 'GitOps Workflow'
88
level: Advanced
99
estimated_time: '40 mins'
1010
---

mintlify/tutorials/gitops-github-workflow.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ author: Adela
44
updated_at: 2025/05/22 18:00
55
tags: Tutorial
66
integrations: GitHub
7-
category: 'Database CI/CD (GitOps)'
7+
category: 'GitOps Workflow'
88
level: Advanced
99
estimated_time: '40 mins'
1010
---

mintlify/tutorials/gitops-gitlab-workflow.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ author: Adela
44
updated_at: 2025/05/12 18:00
55
tags: Tutorial
66
integrations: GitLab
7-
category: 'Database CI/CD (GitOps)'
7+
category: 'GitOps Workflow'
88
level: Advanced
99
estimated_time: '40 mins'
1010
featured: true

0 commit comments

Comments
 (0)