Skip to content

Commit

Permalink
docs: update quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
tianzhou committed Dec 18, 2024
1 parent 6a95091 commit 1429531
Show file tree
Hide file tree
Showing 9 changed files with 37 additions and 16 deletions.
4 changes: 2 additions & 2 deletions content/docs/get-started/step-by-step/add-an-instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Add an Instance
---

`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`.
**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**.

## Prerequisites

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

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.

## Sync instance
## Sync instance schema

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

Expand Down
24 changes: 16 additions & 8 deletions content/docs/get-started/step-by-step/change-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,14 @@
title: Make a Database Schema Change
---

**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.
**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.

## Create an issue
## Create issue

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

![edit-schema](/content/docs/get-started/step-by-step/change-schema/edit-schema.webp)

You may use the **Schema Editor** to visually design the schema.

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

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

## Roll out an issue
## Review issue

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

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

An issue may also require one or multiple manual approvals. Once all approvals are granted, the issue can be rolled out.
An issue may also require one or multiple manual approvals.

## Roll out issue

Once all approvals are granted, the issue can be rolled out.

![roll-out-issue](/content/docs/get-started/step-by-step/change-schema/roll-out-issue.webp)

## Issue lifecycle
## Summary

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

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

Bytebase supports 2 change workflow, **UI** and **GitOps**. Check [Database Change Workflow](/docs/change-database/change-workflow/) for further details.
Check [Database Change Workflow](/docs/change-database/change-workflow/) for further details.
14 changes: 12 additions & 2 deletions content/docs/get-started/step-by-step/create-a-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,26 @@ Go to **Projects** and click **New Project**.

## Transfer a database into the project

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.
<HintBlock type="info">

Go to the project page where you can **create a new database** or **transfer an existing database into the project**.
To make changes to a database, you need to place it in a project first.

</HintBlock>

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**.

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

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

## Manage the members in the project

<HintBlock type="info">

To manage fine-grained database access, check out [Database Permission](/docs/security/database-permission/overview/).

</HintBlock>

A project is only visible to its related **users**. The project creator assumes `Project Owner`role and can manage project members.

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.
Expand Down
11 changes: 7 additions & 4 deletions content/docs/get-started/step-by-step/query-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Query Data
---

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.
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.

## Access SQL Editor

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

## Query data

![query](/content/docs/get-started/step-by-step/query-data/query.webp)
Select a database.

![select-database](/content/docs/get-started/step-by-step/query-data/select-database.webp)

The left sidebar only lists the databases that have been granted query access. Select a database
and run the query.
Run the query.

![query](/content/docs/get-started/step-by-step/query-data/query.webp)

Check out the detailed [SQL Editor](/docs/sql-editor/overview) docs to explore other features.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

0 comments on commit 1429531

Please sign in to comment.