Skip to content

docs: extract docker run with sample data #801

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adela-bytebase merged 2 commits into from
Aug 11, 2025
Merged

docs: extract docker run with sample data #801

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
096ddd5
extract prepare section with sample data
adela-bytebase Aug 11, 2025
cd8026e
integrate with the one in first-schema-change
adela-bytebase Aug 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 ...utorials/first-schema-change/account.webp → ...ontent/docs/tutorials/shared/account.webp
View file
Open in desktop
File renamed without changes
0 ...a-migration/bb-setup-built-in-sample.webp → ...ials/shared/bb-setup-built-in-sample.webp
View file
Open in desktop
File renamed without changes
0 ...ls/first-schema-change/dk-bb-running.webp → .../docs/tutorials/shared/dk-bb-running.webp
View file
Open in desktop
File renamed without changes
15 changes: 15 additions & 0 deletions mintlify/snippets/tutorials/preparation-with-sample-data.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import TerminalDockerRunVolume from '/snippets/install/terminal-docker-run-volume.mdx';

1. Ensure Docker is running, then start the Bytebase container:

<TerminalDockerRunVolume />

![dk-bb-running](/content/docs/tutorials/shared/dk-bb-running.webp)

1. Open Bytebase in [localhost:8080](http://localhost:8080/), fill in the fields and click **Create admin account**. You'll be redirected to Workspace.

![account](/content/docs/tutorials/shared/account.webp)

1. During workspace setup, choose the built-in sample data.

![setup-built-in-sample-data](/content/docs/tutorials/shared/bb-setup-built-in-sample.webp)
12 changes: 2 additions & 10 deletions mintlify/tutorials/deploy-schema-migration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ estimated_time: '30 mins'
featured: true
---

import TerminalDockerRunVolume from '/snippets/install/terminal-docker-run-volume.mdx';
import PreparationWithSampleData from '/snippets/tutorials/preparation-with-sample-data.mdx';

Bytebase provides a powerful GUI for deploying schema migrations. This tutorial walks you through deploying schema changes with features such as SQL Review, rollout policies, custom approval, time scheduling, and more.

Expand All @@ -26,15 +26,7 @@ Bytebase offers **Community**, **Pro**, and **Enterprise** [plans](https://www.b

### Preparation

1. Ensure Docker is running, then start the Bytebase container:

<TerminalDockerRunVolume />

1. After Bytebase starts, visit `localhost:8080`. Register an admin account, and it will be granted the `workspace admin` role automatically.

1. During workspace setup, choose the built-in sample data.

![setup-built-in-sample-data](/content/docs/tutorials/deploy-schema-migration/bb-setup-built-in-sample.webp)
<PreparationWithSampleData />

### Level 1: Automatic rollout in the Test environment (All plans)

Expand Down
14 changes: 3 additions & 11 deletions mintlify/tutorials/first-schema-change.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,13 @@ estimated_time: '5 mins'
featured: true
---

import TerminalDockerRunVolume from '/snippets/install/terminal-docker-run-volume.mdx';
import PreparationWithSampleData from '/snippets/tutorials/preparation-with-sample-data.mdx';

In this tutorial, you'll use the default sample databases to get familiar with the product in the quickest way.

## Step 1 - Run via Docker
## Step 1 - Run via Docker and Setup

1. Install and start [Docker](https://www.docker.com/).
1. Open Terminal to run the command:

<TerminalDockerRunVolume />

![dk-bb-running](/content/docs/tutorials/first-schema-change/dk-bb-running.webp)

1. Open Bytebase in [localhost:8080](http://localhost:8080/), fill in the fields and click **Create admin account**. You'll be redirected to Workspace.
![account](/content/docs/tutorials/first-schema-change/account.webp)
<PreparationWithSampleData />

## Step 2 - Configure the SQL Review

Expand Down