Skip to content

Commit 1429531

Browse files
committed
docs: update quickstart
1 parent 6a95091 commit 1429531

File tree

9 files changed

+37
-16
lines changed

9 files changed

+37
-16
lines changed

content/docs/get-started/step-by-step/add-an-instance.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Add an Instance
33
---
44

5-
`Database Instance` or simply `Instance` models after a single database server which is usually accessed via a host:port address. A typical database instance could be your on-premises MySQL instance, an AWS RDS instance etc. Each `Database Instance` belongs to an `Environment`.
5+
**Database Instance** or simply **Instance** models after a single database server accessed via a host:port address or a primary/replica cluster. A typical database instance could be your on-premises MySQL instance, a PostgreSQL cluster, an AWS RDS instance etc. Each **Database Instance** belongs to an **Environment**.
66

77
## Prerequisites
88

@@ -20,7 +20,7 @@ Go to **Instances** and **Add Instance**.
2020

2121
For **Host or socket**, the screenshot assumes you run Bytebase inside Docker and try to connect to a database instance on the same host, thus it uses `host.docker.internal`. Check out [Instance Connection Configuration](/docs/get-started/instance) for the detailed guide.
2222

23-
## Sync instance
23+
## Sync instance schema
2424

2525
After instance is added, click **Sync Now** to synchronize the instance schema such as its containing databases to Bytebase.
2626

content/docs/get-started/step-by-step/change-schema.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,14 @@
22
title: Make a Database Schema Change
33
---
44

5-
**Issue** drives the database change workflow such as `Database Creation`, `DDL` and `DML`. It's similar to the issue concept in other issue management tools.
5+
**Issue** drives the database change workflow such as `Schema Change (DDL)`, `Data Change (DML)`, and `Database Creation`. It's similar to the issue concept in other issue management tools.
66

7-
## Create an issue
7+
## Create issue
88

99
Go to your project page, choose one or several databases to **Edit Schema**.
1010

11+
![edit-schema](/content/docs/get-started/step-by-step/change-schema/edit-schema.webp)
12+
1113
You may use the **Schema Editor** to visually design the schema.
1214

1315
![schema-editor](/content/docs/get-started/step-by-step/change-schema/schema-editor.webp)
@@ -23,18 +25,24 @@ Once you finish writing the SQL, click **Preview issue**.
2325

2426
By default, Bytebase will create a **Rollout issue**. You can check **SQL Review Only** to create a review-only plan.
2527

26-
## Roll out an issue
28+
## Review issue
2729

28-
![rollout-issue](/content/docs/get-started/step-by-step/change-schema/rollout-issue.webp)
30+
![review-issue](/content/docs/get-started/step-by-step/change-schema/review-issue.webp)
2931

3032
If there's a [SQL review](/docs/sql-review/overview) warning, you may need to fix it first.
3133

32-
An issue may also require one or multiple manual approvals. Once all approvals are granted, the issue can be rolled out.
34+
An issue may also require one or multiple manual approvals.
35+
36+
## Roll out issue
37+
38+
Once all approvals are granted, the issue can be rolled out.
39+
40+
![roll-out-issue](/content/docs/get-started/step-by-step/change-schema/roll-out-issue.webp)
3341

34-
## Issue lifecycle
42+
## Summary
3543

36-
Here's a graph demonstrating the issue lifecycle.
44+
An issue lifecycle: Create -> Review -> Approve -> Roll out.
3745

3846
![issue-lifecycle](/content/docs/get-started/step-by-step/change-schema/issue-lifecycle.webp)
3947

40-
Bytebase supports 2 change workflow, **UI** and **GitOps**. Check [Database Change Workflow](/docs/change-database/change-workflow/) for further details.
48+
Check [Database Change Workflow](/docs/change-database/change-workflow/) for further details.

content/docs/get-started/step-by-step/create-a-project.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,26 @@ Go to **Projects** and click **New Project**.
1616

1717
## Transfer a database into the project
1818

19-
To make changes to a database, you need to place it in a project first. Once a project is created, you need to fill it with some Databases.
19+
<HintBlock type="info">
2020

21-
Go to the project page where you can **create a new database** or **transfer an existing database into the project**.
21+
To make changes to a database, you need to place it in a project first.
22+
23+
</HintBlock>
24+
25+
Once a project is created, you need to fill it with some Databases. Go to the project page where you can **create a new database** or **transfer an existing database into the project**.
2226

2327
![manage-db](/content/docs/get-started/step-by-step/create-a-project/manage-db.webp)
2428

2529
![manage-db-2](/content/docs/get-started/step-by-step/create-a-project/manage-db-2.webp)
2630

2731
## Manage the members in the project
2832

33+
<HintBlock type="info">
34+
35+
To manage fine-grained database access, check out [Database Permission](/docs/security/database-permission/overview/).
36+
37+
</HintBlock>
38+
2939
A project is only visible to its related **users**. The project creator assumes `Project Owner`role and can manage project members.
3040

3141
Go to the project page. Click **Manage** > **Members** on the left sidebar. **Grant Access** to add new project members from workspace level accounts. You can assign project-level roles to the members.

content/docs/get-started/step-by-step/query-data.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Query Data
33
---
44

5-
Bytebase also provides a web-based SQL Editor for querying data. Unlike traditional client-side SQL clients, this server-side SQL Editor allows you to enable data access control, data masking, audit logging, etc.
5+
Bytebase also provides a web-based SQL Editor for querying data. Unlike traditional client-side SQL clients, this server-side SQL Editor can enforce fine-grained data access control, data masking, audit logging, etc.
66

77
## Access SQL Editor
88

@@ -14,9 +14,12 @@ SQL Editor can be acccess from the top bar or from the database.
1414

1515
## Query data
1616

17-
![query](/content/docs/get-started/step-by-step/query-data/query.webp)
17+
Select a database.
18+
19+
![select-database](/content/docs/get-started/step-by-step/query-data/select-database.webp)
1820

19-
The left sidebar only lists the databases that have been granted query access. Select a database
20-
and run the query.
21+
Run the query.
22+
23+
![query](/content/docs/get-started/step-by-step/query-data/query.webp)
2124

2225
Check out the detailed [SQL Editor](/docs/sql-editor/overview) docs to explore other features.
12.8 KB
Loading

public/content/docs/get-started/step-by-step/change-schema/rollout-issue.webp renamed to public/content/docs/get-started/step-by-step/change-schema/review-issue.webp

File renamed without changes.
26.5 KB
Loading
-47.3 KB
Loading
9.27 KB
Loading

0 commit comments

Comments
 (0)