Skip to content

Commit c62cb9a

Browse files
committed
chore: move shared doc folder
1 parent c98a831 commit c62cb9a

34 files changed

+84
-80
lines changed

content/docs/api/issue.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Inside the plan, create one or more sheets if needed. Then you orchestrate the o
8787

8888
Each spec corresponds to a task. A task is a single change unit. Tasks run in the following order:
8989

90-
<IncludeBlock url="/docs/tutorials/share/task-run-order"></IncludeBlock>
90+
<IncludeBlock url="/docs/share/tutorials/task-run-order"></IncludeBlock>
9191

9292
If you want to enforce strict running order inside a step/stage. You can specify `dependsOnSpecs` with the previous task.
9393

content/docs/change-database/change-workflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ one or more SQL statements to be executed.
5151

5252
Tasks run in the following order:
5353

54-
<IncludeBlock url="/docs/tutorials/share/task-run-order"></IncludeBlock>
54+
<IncludeBlock url="/docs/share/tutorials/task-run-order"></IncludeBlock>
5555

5656
### Task Detail
5757

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
| Access Level | Operation | Permission |
2+
| ------------ | ------------------------------------------------------ | ------------------------ |
3+
| Read | [EXPLAIN](/docs/security/database-permission/explain/) | `databases.queryExplain` |
4+
| | [Query](/docs/security/database-permission/query/) | `databases.query` |
5+
| | [Export](/docs/security/database-permission/export/) | `databases.export` |
6+
| Write | Data-modifying DML | `databases.queryDML` |
7+
| | DDL | `databases.queryDDL` |
8+
| Admin | [Admin](/docs/sql-editor/admin-mode/) | `instances.adminExecute` |

content/docs/tutorials/share/create-service-account.md renamed to content/docs/share/tutorials/create-service-account.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
1. Log in as the admin user, and go to **Security & Policy > Users & Groups**. Click **+ Add User**, fill in with `api-example`, choose the `DBA` role that is sufficient for this tutorial and click **Confirm**.
2-
![service-account-create](/content/docs/tutorials/share/add-service-account.webp)
2+
![service-account-create](/content/docs/share/tutorials/add-service-account.webp)
33

44
1. Find the newly created service account and click on **Copy Service Key**. We will use this token to authenticate the API calls.
5-
![service-account-key](/content/docs/tutorials/share/service-account-key.webp)
5+
![service-account-key](/content/docs/share/tutorials/service-account-key.webp)

content/docs/tutorials/share/database-workflow-advanced-features.md renamed to content/docs/share/tutorials/database-workflow-advanced-features.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ You may upgrade to Enterprise plan to explore more features.
44

55
Go to **Environments** > **Prod**, Find **Rollout policy** section, and choose **Manual rollout** > **Require rolling out by dedicated roles**.
66

7-
![bb-env-prod-manual-rollout](/content/docs/tutorials/share/bb-env-prod-manual-rollout.webp)
7+
![bb-env-prod-manual-rollout](/content/docs/share/tutorials/bb-env-prod-manual-rollout.webp)
88

99
### Custom Approval
1010

1111
1. Go to **CI/CD** > **Custom Approval**. Set `Project Owner -> DBA` as Approval flow for **DDL** > **High Risk**.
1212

13-
![bb-custom-approval](/content/docs/tutorials/share/bb-custom-approval.webp)
13+
![bb-custom-approval](/content/docs/share/tutorials/bb-custom-approval.webp)
1414

1515
1. Go to **CI/CD** > **Risk Center**. Click **Add rule** and click **Load** for the first template. Click **Add**.
1616

17-
![bb-risk-center-ddl-high](/content/docs/tutorials/share/bb-risk-center-ddl-high.webp)
17+
![bb-risk-center-ddl-high](/content/docs/share/tutorials/bb-risk-center-ddl-high.webp)
1818

1919
### Schema Drift
2020

@@ -31,6 +31,6 @@ Bytebase has built-in [schema drift detection](/docs/change-database/drift-detec
3131

3232
1. Go back to Bytebase Console, and click **Databases** > `employee` under `Prod`. Click **Sync Now**. After seeing the success message, refresh the page. You'll see the schema drift. You may configure auto scan on instance detail page to avoid manual sync.
3333

34-
![bb-db-schema-drift](/content/docs/tutorials/share/bb-db-schema-drift.webp)
34+
![bb-db-schema-drift](/content/docs/share/tutorials/bb-db-schema-drift.webp)
3535

36-
14. Go to **Database** > **Anomalies**, and you'll see the Schema drift there too.
36+
1. Go to **Database** > **Anomalies**, and you'll see the Schema drift there too.

content/docs/tutorials/share/database-workflow.md renamed to content/docs/share/tutorials/database-workflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ DORA (DevOps Research & Assessment) [pointed out](https://cloud.google.com/archi
44

55
But how does it work, really? Here, we present our envisioned Database CI/CD workflow.
66

7-
![database-devops-workflow](/content/docs/tutorials/share/cicd-workflow.webp)
7+
![database-devops-workflow](/content/docs/share/tutorials/cicd-workflow.webp)
88

99
1. The developer creates a Pull Request containing the SQL script;
1010
1. SQL Review CI is automatically triggered to review SQL and offers suggestions via a comment in the PR;
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
1. Go to **CI/CD > SQL Review** in workspace, choose `Prod` as the environment. Make sure a SQL review policy is attached and enabled on `Prod`.
22

3-
![bb-sql-review](/content/docs/tutorials/share/bb-sql-review.webp)
3+
![bb-sql-review](/content/docs/share/tutorials/bb-sql-review.webp)
44

55
1. Click **Edit**, click **PostgreSQL** tab. Make sure `Enforce "NOT NULL" constraints on columns` is enabled. This is to make sure the SQL Review can work.
66

7-
![bb-sql-review-not-null](/content/docs/tutorials/share/bb-sql-review-not-null.webp)
7+
![bb-sql-review-not-null](/content/docs/share/tutorials/bb-sql-review-not-null.webp)
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)