diff --git a/content/blog/2023-q3-retrospect.md b/content/blog/2023-q3-retrospect.md index 43f488390..eddab0ff9 100644 --- a/content/blog/2023-q3-retrospect.md +++ b/content/blog/2023-q3-retrospect.md @@ -35,10 +35,6 @@ Bytebase keeps up with the bi-weekly release cadence and released 7 versions. - Oracle: Schema Sync. - RisingWave: basic support. -### GitOps Integration - -- Support [GitHub Enterprise](https://docs.bytebase.com/vcs-integration/github-enterprise/). -- Support [Azure DevOps](https://docs.bytebase.com/vcs-integration/azure-devops/). ### Database Change Management diff --git a/content/blog/all-database-tools-bytebase-replaces.md b/content/blog/all-database-tools-bytebase-replaces.md index 5d9020cc7..b1c880f94 100644 --- a/content/blog/all-database-tools-bytebase-replaces.md +++ b/content/blog/all-database-tools-bytebase-replaces.md @@ -32,7 +32,7 @@ for DBAs and developers to collaborate on database changes. - [SQL linter](https://docs.bytebase.com/sql-review/overview/) to detect anti-patterns. ![schema-review-table-drop-naming](/content/docs/sql-review/schema-review-table-drop-naming.webp) - [Streamline the change](https://docs.bytebase.com/change-database/batch-change/) across different environments and allow to batch change many databases consistently. -- [GitOps integration](https://docs.bytebase.com/vcs-integration/overview/) with mainstream VCSs to enable database-as-code workflow. +- [GitOps integration](https://docs.bytebase.com/gitops/overview/) with mainstream VCSs to enable database-as-code workflow. - [Online schema migration for MySQL](https://docs.bytebase.com/change-database/online-schema-migration-for-mysql/) with gh-ost integration. ## Change Coordination diff --git a/content/blog/bytebase-github-technology-partner.md b/content/blog/bytebase-github-technology-partner.md index 51c2d0848..11f62814f 100644 --- a/content/blog/bytebase-github-technology-partner.md +++ b/content/blog/bytebase-github-technology-partner.md @@ -25,7 +25,7 @@ Once configured, if a SQL statement in your PR violates the review rule, you wil ![sql-review-github](/content/blog/bytebase-github-technology-partner/sql-review-github.webp) -In addition, you can take database management one step further by configuring the [GitOps workflow](https://docs.bytebase.com/vcs-integration/overview), which can be defined as "Database-as-code". This enables an integrated CI/CD process from code changes to database changes. The database change scripts you submit to your GitHub repo will automatically trigger Bytebase's SQL review and deployment pipeline. This enables an integrated CI/CD process from code changes to database changes. +In addition, you can take database management one step further by configuring the [GitOps workflow](https://docs.bytebase.com/gitops/overview), which can be defined as "Database-as-code". This enables an integrated CI/CD process from code changes to database changes. The database change scripts you submit to your GitHub repo will automatically trigger Bytebase's SQL review and deployment pipeline. This enables an integrated CI/CD process from code changes to database changes. ![gitops-bytebase](/content/blog/bytebase-github-technology-partner/gitops-bytebase.webp) diff --git a/content/blog/database-cicd-best-practice.md b/content/blog/database-cicd-best-practice.md index 975c871ce..9caf63e46 100644 --- a/content/blog/database-cicd-best-practice.md +++ b/content/blog/database-cicd-best-practice.md @@ -129,7 +129,7 @@ This process can be divided into three main tasks: ![](/content/blog/database-cicd-best-practice/schema-review.webp) -3. **[Set up GitOps](https://docs.bytebase.com/vcs-integration/overview)**. Configure the GitOps workflow in a given project to monitor changes in the VCS and automatically kick start the review process. +3. **[Set up GitOps](https://docs.bytebase.com/gitops/overview)**. Configure the GitOps workflow in a given project to monitor changes in the VCS and automatically kick start the review process. ![](/content/blog/database-cicd-best-practice/gitops.webp) diff --git a/content/blog/database-version-control-state-based-vs-migration-based.md b/content/blog/database-version-control-state-based-vs-migration-based.md index 436fbc2dc..3cbfb1f79 100644 --- a/content/blog/database-version-control-state-based-vs-migration-based.md +++ b/content/blog/database-version-control-state-based-vs-migration-based.md @@ -95,7 +95,7 @@ At the same time, we also understand the benefit of state-based approach. That's 1. For every schema migration, Bytebase will record the schema snapshot. 2. If team manage database schema under version control system, they can configure Bytebase to write the schema snapshot back to the repository at a specified path. -With that, it makes Bytebase become a hybrid schema migration system. Team using Bytebase retain all the existing benefits of migration-based approach, meanwhile they now can have a single latest schema file. This file is the single of truth of their database schema, which brings the core merit from state-based approach. Please do checkout out [user guide](https://docs.bytebase.com/vcs-integration/add-gitops-connector#step-3---configure-deploy) on how to configure this. +With that, it makes Bytebase become a hybrid schema migration system. Team using Bytebase retain all the existing benefits of migration-based approach, meanwhile they now can have a single latest schema file. This file is the single of truth of their database schema, which brings the core merit from state-based approach. Please do checkout out [user guide](https://docs.bytebase.com/gitops/overview) on how to configure this. As a side note, I do hope database engine could innovate in the direction as Kubernetes to pave the way for state-based approach. Actually, Google's own database system Spanner does provide these support and you know what, every team at Google use the state-based approach to manage their database schemas. diff --git a/content/blog/ev-manufacturer-case-study.md b/content/blog/ev-manufacturer-case-study.md index c5fcd103b..fe0951826 100644 --- a/content/blog/ev-manufacturer-case-study.md +++ b/content/blog/ev-manufacturer-case-study.md @@ -33,7 +33,7 @@ Introduce Bytebase, an open-source database DevOps tool, which offers a web-base ### Manage SQL scripts and initiate change requests directly through code repos -SQL [is also code](/blog/database-as-code) and should be orderly and consistent. With Bytebase, they are able to [integrate SQL scripts into their code repository (GitLab)](https://docs.bytebase.com/vcs-integration/overview/): all SQL scripts will automatically trigger issues when merged into the specified branch. Devs can complete all their tasks within their familiar tool, greatly improving efficiency while reducing the chances of careless mistakes caused by copying and pasting back and forth. +SQL [is also code](/blog/database-as-code) and should be orderly and consistent. With Bytebase, they are able to [integrate SQL scripts into their code repository (GitLab)](https://docs.bytebase.com/gitops/overview/): all SQL scripts will automatically trigger issues when merged into the specified branch. Devs can complete all their tasks within their familiar tool, greatly improving efficiency while reducing the chances of careless mistakes caused by copying and pasting back and forth. ### Notification on IM apps diff --git a/content/blog/how-bytebase-tracks-database-change.md b/content/blog/how-bytebase-tracks-database-change.md index 7a4a30f52..773e5bb45 100644 --- a/content/blog/how-bytebase-tracks-database-change.md +++ b/content/blog/how-bytebase-tracks-database-change.md @@ -22,7 +22,7 @@ to a single database as well as changes to hundreds of databases spanning multip ![_](/content/blog/how-bytebase-tracks-database-change/issue-detail-who.webp) 1. Issue Creator -1. Reviewers according to the [Rollout Policy](https://docs.bytebase.com/administration/environment-policy/rollout-policy/) +1. Reviewers according to the [Rollout Policy](https://docs.bytebase.com/change-database/environment-policy/rollout-policy/) 1. Subscribers interested in the progress. 1. Other participants can comment. diff --git a/content/blog/multi-tenant-database-architecture-patterns-explained.md b/content/blog/multi-tenant-database-architecture-patterns-explained.md index 4f8b4c00b..e4a2d0621 100644 --- a/content/blog/multi-tenant-database-architecture-patterns-explained.md +++ b/content/blog/multi-tenant-database-architecture-patterns-explained.md @@ -194,6 +194,6 @@ To tackle this, you should adopt best practices: -Bytebase offers [batch change](https://docs.bytebase.com/change-database/batch-change/), [SQL Review](https://docs.bytebase.com/sql-review/overview/), [GitOps](https://docs.bytebase.com/vcs-integration/overview/) to streamline and simplify schema migrations for the **Database per Tenant** model. +Bytebase offers [batch change](https://docs.bytebase.com/change-database/batch-change/), [SQL Review](https://docs.bytebase.com/sql-review/overview/), [GitOps](https://docs.bytebase.com/gitops/overview/) to streamline and simplify schema migrations for the **Database per Tenant** model. diff --git a/content/blog/note-case-study.md b/content/blog/note-case-study.md index 1f6cc8467..aed0b8a2c 100644 --- a/content/blog/note-case-study.md +++ b/content/blog/note-case-study.md @@ -91,6 +91,6 @@ After implementing Bytebase's database access control, the following issues have At present, only read queries are utilized; the aim is to enable modifications for both DML and DDL directly on Bytebase. -- [GitOps workflow with GitHub](https://docs.bytebase.com/vcs-integration/overview/) +- [GitOps workflow with GitHub](https://docs.bytebase.com/gitops/overview/) Given that SQL is currently managed through GitHub Issues in the existing business process, the introduction of GitOps is expected to enhance operational efficiency. diff --git a/content/blog/postgres-create-index-concurrently.md b/content/blog/postgres-create-index-concurrently.md index ce0a64231..76a1c0461 100644 --- a/content/blog/postgres-create-index-concurrently.md +++ b/content/blog/postgres-create-index-concurrently.md @@ -157,7 +157,7 @@ To prevent developers from running `CREATE INDEX` and accidentally locking the d -[Bytebase SQL Review](https://docs.bytebase.com/sql-review/review-rules#create-index-concurrently) provides automated enforcement of the `CREATE INDEX CONCURRENTLY` rule and can be integrated with [CI/CD pipelines](https://docs.bytebase.com/vcs-integration/overview#github-actions) to catch violations before deployment. +[Bytebase SQL Review](https://docs.bytebase.com/sql-review/review-rules#create-index-concurrently) provides automated enforcement of the `CREATE INDEX CONCURRENTLY` rule and can be integrated with [CI/CD pipelines](https://docs.bytebase.com/gitops/overview) to catch violations before deployment. diff --git a/content/blog/salla-case-study.md b/content/blog/salla-case-study.md index 9f9cb49c7..712fc57e5 100644 --- a/content/blog/salla-case-study.md +++ b/content/blog/salla-case-study.md @@ -64,5 +64,5 @@ With the entire change process integrated into a single platform, their release Salla has plans to integrate GitOps and Terraform Bytebase Provider into their workflow. -- Through the [GitOps workflow](https://docs.bytebase.com/vcs-integration/overview/), developers can directly submit change requests through their code repository, further integrating database management with the development workflow. +- Through the [GitOps workflow](https://docs.bytebase.com/gitops/overview/), developers can directly submit change requests through their code repository, further integrating database management with the development workflow. - With [Terraform Bytebase Provider](https://docs.bytebase.com/tutorials/manage-databases-with-terraform/), all Bytebase configurations can be codified, making it even easier for DBAs to configure batch access permissions. diff --git a/content/blog/stop-using-navicat.md b/content/blog/stop-using-navicat.md index ce2c34e6a..25f91dbe3 100644 --- a/content/blog/stop-using-navicat.md +++ b/content/blog/stop-using-navicat.md @@ -90,7 +90,7 @@ Bytebase is a web-based product with server-side capabilities that can fill the ### Integration with GitLab / GitHub to synchronize SQL scripts -![_](/content/blog/stop-using-navicat/bytebase-vcs-integration.webp) +![_](/content/blog/stop-using-navicat/bytebase-gitops.webp) ### Audit Log diff --git a/content/blog/what-is-database-devops.md b/content/blog/what-is-database-devops.md index cae2eaf2f..725995d90 100644 --- a/content/blog/what-is-database-devops.md +++ b/content/blog/what-is-database-devops.md @@ -78,7 +78,7 @@ Automation can be applied in several places: -Bytebase automates database tasks via [GitOps](https://docs.bytebase.com/vcs-integration/overview/), [SQL Review](https://docs.bytebase.com/sql-review/overview/), [built-in rollback](https://docs.bytebase.com/change-database/rollback-data-changes/), [Webhook Integration](https://docs.bytebase.com/change-database/webhook/), and [API](https://docs.bytebase.com/api/overview/). +Bytebase automates database tasks via [GitOps](https://docs.bytebase.com/gitops/overview/), [SQL Review](https://docs.bytebase.com/sql-review/overview/), [built-in rollback](https://docs.bytebase.com/change-database/rollback-data-changes/), [Webhook Integration](https://docs.bytebase.com/change-database/webhook/), and [API](https://docs.bytebase.com/api/overview/). diff --git a/content/blog/what-is-database-devsecops.md b/content/blog/what-is-database-devsecops.md index 39f5039c9..db8c3dc02 100644 --- a/content/blog/what-is-database-devsecops.md +++ b/content/blog/what-is-database-devsecops.md @@ -47,7 +47,7 @@ modifications are applied uniformly across environments. -Bytebase provides [built-in GitOps integration](https://docs.bytebase.com/vcs-integration/overview/) and [SQL Review](https://docs.bytebase.com/sql-review/overview/) to detect erroneous SQLs automatically. +Bytebase provides [built-in GitOps integration](https://docs.bytebase.com/gitops/overview/) and [SQL Review](https://docs.bytebase.com/sql-review/overview/) to detect erroneous SQLs automatically. diff --git a/content/blog/what-is-database-schema-drift.md b/content/blog/what-is-database-schema-drift.md index 4f3994070..0fdb2f908 100644 --- a/content/blog/what-is-database-schema-drift.md +++ b/content/blog/what-is-database-schema-drift.md @@ -60,5 +60,5 @@ If this interests you, please do check out our [demo](/view-live-demo) or use 1 - [What is Database Change Management?](/blog/what-is-database-change-management) - [Database-as-Code](/blog/database-as-code) -- [Bytebase Database-as-Code VCS integration](https://docs.bytebase.com/vcs-integration/overview) +- [Bytebase Database-as-Code VCS integration](https://docs.bytebase.com/gitops/overview) - [Database Version Control, State-based or Migration-based?](/blog/database-version-control-state-based-vs-migration-based) diff --git a/content/blog/what-is-ddl-and-dml-in-sql-database.md b/content/blog/what-is-ddl-and-dml-in-sql-database.md index 15ee4d8d2..143f0b398 100644 --- a/content/blog/what-is-ddl-and-dml-in-sql-database.md +++ b/content/blog/what-is-ddl-and-dml-in-sql-database.md @@ -117,4 +117,4 @@ Data Manipulation Language (DML) consists of SQL commands that manipulate the da | **Privilege Level** | Higher (admin-level) | Lower (user-level) | | **Impact** | Structural changes | Data changes | -Effective database change management requires proper control over both DDL and DML operations. Tools like Bytebase provide features such as [SQL review policies](https://docs.bytebase.com/sql-review), [version control for schema changes](https://docs.bytebase.com/vcs-integration), [approval workflows](https://docs.bytebase.com/change-workflow), [automatic backups](https://docs.bytebase.com/backup-restore), and [audit capabilities](https://docs.bytebase.com/audit-logging) to ensure safe and efficient database changes. +Effective database change management requires proper control over both DDL and DML operations. Tools like Bytebase provide features such as [SQL review policies](https://docs.bytebase.com/sql-review), [version control for schema changes](https://docs.bytebase.com/gitops), [approval workflows](https://docs.bytebase.com/change-workflow), [automatic backups](https://docs.bytebase.com/backup-restore), and [audit capabilities](https://docs.bytebase.com/audit-logging) to ensure safe and efficient database changes. diff --git a/mintlify/administration/custom-approval.mdx b/mintlify/administration/custom-approval.mdx index 681d0051f..2667e641a 100644 --- a/mintlify/administration/custom-approval.mdx +++ b/mintlify/administration/custom-approval.mdx @@ -29,7 +29,7 @@ An approval flow consists of one or more **approval nodes** arranged in sequence - All nodes must be approved before the issue proceeds to rollout -After approval, the actual deployment may still require manual action depending on your [rollout policy](/administration/environment-policy/rollout-policy/) configuration. +After approval, the actual deployment may still require manual action depending on your [rollout policy](/change-database/environment-policy/rollout-policy/) configuration. ![Approval Flow](/content/docs/administration/custom-approval/edit-approval-flow.webp) @@ -46,7 +46,7 @@ After approval, the actual deployment may still require manual action depending ### Step 2: Assign Flows to Risk Levels 1. Click the **Rules** tab -2. Select an approval flow for each [risk level](/administration/risk-center) +2. Select an approval flow for each risk level 3. Choose "Skip manual approval" if no approval is needed for a specific risk level ## Working with Custom Roles diff --git a/mintlify/administration/roles.mdx b/mintlify/administration/roles.mdx index d4afd8e80..04c9d0077 100644 --- a/mintlify/administration/roles.mdx +++ b/mintlify/administration/roles.mdx @@ -195,4 +195,4 @@ User can save sheets from [SQL Editor](/sql-editor/overview). A sheet always bel | Subscribe/Unsubscribe | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | Add comment | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | -\* `Project Owner` can change issue status when the current active [Environment Rollout Policy](/administration/environment-policy/rollout-policy) is set to **Require manual rolling out**. \ No newline at end of file +\* `Project Owner` can change issue status when the current active [Environment Rollout Policy](/change-database/environment-policy/rollout-policy) is set to **Require manual rolling out**. \ No newline at end of file diff --git a/mintlify/administration/environment-policy/overview.mdx b/mintlify/change-database/environment-policy/overview.mdx similarity index 66% rename from mintlify/administration/environment-policy/overview.mdx rename to mintlify/change-database/environment-policy/overview.mdx index 5e3c2314b..a71f1cfdd 100644 --- a/mintlify/administration/environment-policy/overview.mdx +++ b/mintlify/change-database/environment-policy/overview.mdx @@ -6,11 +6,11 @@ title: Environment Policy Even if you have `sql.dml` and `sql.ddl` [database permissions](/security/database-permission/overview/), you can only run read-only statements such as `SELECT` in SQL Editor by default. If you attempt to run mutation DML or DDL, it will prompt you to submit an issue. -![prompt-issue](/content/docs/administration/environment-policy/prompt-issue.webp) +![prompt-issue](/content/docs/change-database/environment-policy/prompt-issue.webp) If you want to run those statements directly in SQL Editor, you need to turn on the **statement execution** setting. -![statement-execution](/content/docs/administration/environment-policy/statement-execution.webp) +![statement-execution](/content/docs/change-database/environment-policy/statement-execution.webp) ## Environment tier @@ -20,14 +20,14 @@ If you want to run those statements directly in SQL Editor, you need to turn on You can configure any color for an environment either by inputting in **HEX** tab or choosing one in the palette. -![env-color](/content/docs/administration/environment-policy/env-color.webp) +![env-color](/content/docs/change-database/environment-policy/env-color.webp) SQL Editor then displays the configured color tab. -![env-color-sql-editor](/content/docs/administration/environment-policy/env-color-sql-editor.webp) +![env-color-sql-editor](/content/docs/change-database/environment-policy/env-color-sql-editor.webp) ### Production indicator Once you mark an environment as a production environment, Bytebase will attach a shield icon 🛡️ besides the environment name. -![tier-envs](/content/docs/administration/environment-policy/tier-envs.webp) +![tier-envs](/content/docs/change-database/environment-policy/tier-envs.webp) diff --git a/mintlify/administration/environment-policy/rollout-policy.mdx b/mintlify/change-database/environment-policy/rollout-policy.mdx similarity index 93% rename from mintlify/administration/environment-policy/rollout-policy.mdx rename to mintlify/change-database/environment-policy/rollout-policy.mdx index c097cf9a8..9525d51bd 100644 --- a/mintlify/administration/environment-policy/rollout-policy.mdx +++ b/mintlify/change-database/environment-policy/rollout-policy.mdx @@ -13,7 +13,7 @@ the issue is approved by the others, you **can** deploy your own issue if qualif `Workspace Admin` or `DBA` can configure the **Rollout policy** for a particular environment from the **Environment** detail page: -![environment-rollout](/content/docs/administration/environment-policy/bb-env-rollout.webp) +![environment-rollout](/content/docs/change-database/environment-policy/bb-env-rollout.webp) This setting will affect projects using either [UI workflow or GitOps workflow](/change-database/change-workflow). The rollout policy determines who will rollout the database changes. diff --git a/mintlify/administration/environment-policy/tier.mdx b/mintlify/change-database/environment-policy/tier.mdx similarity index 100% rename from mintlify/administration/environment-policy/tier.mdx rename to mintlify/change-database/environment-policy/tier.mdx diff --git a/mintlify/administration/risk-center.mdx b/mintlify/change-database/risk-center.mdx similarity index 100% rename from mintlify/administration/risk-center.mdx rename to mintlify/change-database/risk-center.mdx diff --git a/mintlify/administration/schema-template.mdx b/mintlify/change-database/schema-template.mdx similarity index 100% rename from mintlify/administration/schema-template.mdx rename to mintlify/change-database/schema-template.mdx diff --git a/mintlify/changelog/bytebase-0-5-0.mdx b/mintlify/changelog/bytebase-0-5-0.mdx index 927df6241..75f25c2f0 100644 --- a/mintlify/changelog/bytebase-0-5-0.mdx +++ b/mintlify/changelog/bytebase-0-5-0.mdx @@ -15,8 +15,6 @@ import InstallUpgrade from '/snippets/install/install-upgrade.mdx'; ### Version Control Workflow enhancement -- Allow user to specify the migration file path template. [Detailed guide](https://docs.bytebase.com/use-bytebase/vcs-integration/organize-repository-files#file-path-template) -- Allow user to specify the schema path template. **This is useful to let repository always keep a complete schema of the corresponding database.**[Detailed guide](https://docs.bytebase.com/use-bytebase/vcs-integration/organize-repository-files#schema-path-template) - Record schema snapshot in every migration history record ### A dedicated page for individual migration history diff --git a/mintlify/changelog/bytebase-1-12-1.mdx b/mintlify/changelog/bytebase-1-12-1.mdx index fd50aeeeb..ba43998f7 100644 --- a/mintlify/changelog/bytebase-1-12-1.mdx +++ b/mintlify/changelog/bytebase-1-12-1.mdx @@ -21,7 +21,7 @@ description: '- Support OAuth 2.0 for Single Sign-On (SSO). - Support change and - Start a 14-day trial of the Enterprise Plan by default. - Improved Schema Editor's UX. - Improved Schema Diagram: filtering, navigation, focusing and export PNG files. [/change-database/schema-diagram](/sql-editor/schema-diagram) -- Rename "Protected environment" to "Production environment". [/administration/environment-policy/tier](/administration/environment-policy/tier) +- Rename "Protected environment" to "Production environment". [/change-database/environment-policy/tier](/change-database/environment-policy/tier) - Improved schema viewing and editing experience in SQL Editor. - Add an icon to identify sensitive data columns in the query result of SQL Editor. diff --git a/mintlify/changelog/bytebase-1-13-0.mdx b/mintlify/changelog/bytebase-1-13-0.mdx index 08915f5a1..55e6d91fe 100644 --- a/mintlify/changelog/bytebase-1-13-0.mdx +++ b/mintlify/changelog/bytebase-1-13-0.mdx @@ -11,7 +11,7 @@ import InstallUpgrade from '/snippets/install/install-upgrade.mdx'; - Generate SQL statements to rollback DML for MySQL. [/change-database/rollback-data-changes](/change-database/rollback-data-changes) - Support Single Sign-On (SSO) with OIDC. [/administration/sso/oidc](/administration/sso/oidc) -- GitOps workflow now supports GitLab.com as a VCS provider. Now Bytebase supports GitLab.com, GitHub.com and GitLab self-hosted. [/vcs-integration/overview#gitlab-ci](/vcs-integration/overview#gitlab-ci) +- GitOps workflow now supports GitLab.com as a VCS provider. Now Bytebase supports GitLab.com, GitHub.com and GitLab self-hosted. [/gitops/overview](/gitops/overview) ## 🎄 Enhancements diff --git a/mintlify/changelog/bytebase-1-15-0.mdx b/mintlify/changelog/bytebase-1-15-0.mdx index 48dedd5f4..9ba0f9941 100644 --- a/mintlify/changelog/bytebase-1-15-0.mdx +++ b/mintlify/changelog/bytebase-1-15-0.mdx @@ -11,7 +11,7 @@ import InstallUpgrade from '/snippets/install/install-upgrade.mdx'; - Bytebase now offers a Cloud version [https://hub.bytebase.com/](https://hub.bytebase.com/). -- GitOps supports Bitbucket Cloud ([bitbucket.org](https://bitbucket.org)) as the Git provider. [/vcs-integration/overview#bitbucket-pipelines](/vcs-integration/overview#bitbucket-pipelines) +- GitOps supports Bitbucket Cloud ([bitbucket.org](https://bitbucket.org)) as the Git provider. [/gitops/overview](/gitops/overview) ## 🎄 Enhancements diff --git a/mintlify/changelog/bytebase-2-15-0.mdx b/mintlify/changelog/bytebase-2-15-0.mdx index aaadc210d..3cac331d4 100644 --- a/mintlify/changelog/bytebase-2-15-0.mdx +++ b/mintlify/changelog/bytebase-2-15-0.mdx @@ -9,7 +9,7 @@ import InstallUpgrade from '/snippets/install/install-upgrade.mdx'; ## 🔔 Brand New GitOps -_The [new GitOps workflow](/vcs-integration/overview/) is not compatible with the old version, if you need assistance migrating to the new version, please consult us._ +_The [new GitOps workflow](/gitops/overview/) is not compatible with the old version, if you need assistance migrating to the new version, please consult us._ - Use access tokens for authentication. - Support multiple VCS connectors in a project. diff --git a/mintlify/changelog/bytebase-3-5-0.mdx b/mintlify/changelog/bytebase-3-5-0.mdx index b4ab148dc..a81e95535 100644 --- a/mintlify/changelog/bytebase-3-5-0.mdx +++ b/mintlify/changelog/bytebase-3-5-0.mdx @@ -16,7 +16,7 @@ import InstallUpgrade from '/snippets/install/install-upgrade.mdx'; - Deprecated slow query feature. - To simplify the deployment process, the custom deployment configuration feature has been removed. Deployments will now follow the straightforward order of your defined environments. For canary deployments, create a separate `canary` environment. Then, point your database environment to this canary environment. - Deprecated multitenancy feature. -- Deprecated [built-in GitOps feature](https://www.bytebase.com/docs/vcs-integration/overview/#legacy-gitops), now you can use [GitOps in a new way](https://www.bytebase.com/docs/tutorials/gitops-github-workflow/). +- Deprecated built-in GitOps feature], now you can use [GitOps in a new way](https://www.bytebase.com/docs/tutorials/gitops-github-workflow/). - Removed custom project webhook endpoint. - API support pagination and filter. diff --git a/mintlify/docs.json b/mintlify/docs.json index 428019ce0..8377d6485 100644 --- a/mintlify/docs.json +++ b/mintlify/docs.json @@ -117,7 +117,7 @@ { "group": "Rollout", "pages": [ - "administration/environment-policy/rollout-policy", + "change-database/environment-policy/rollout-policy", "change-database/scheduled-rollout", "change-database/change-history" ] @@ -137,10 +137,10 @@ "group": "Settings", "pages": [ "change-database/webhook", - "administration/risk-center", + "change-database/risk-center", "change-database/issue", "change-database/transaction-mode", - "administration/schema-template" + "change-database/schema-template" ] }, "change-database/troubleshoot" @@ -149,8 +149,8 @@ { "group": "GitOps Workflow", "pages": [ - "vcs-integration/overview", - "vcs-integration/release" + "gitops/overview", + "gitops/release" ] } ] @@ -232,7 +232,7 @@ "administration/license", "administration/mode", "ai-assistant", - "administration/environment-policy/overview", + "change-database/environment-policy/overview", "administration/customize-logo", "security/watermark", "administration/announcement", diff --git a/mintlify/get-started/cloud.mdx b/mintlify/get-started/cloud.mdx index ba667a9e5..efa149cb1 100644 --- a/mintlify/get-started/cloud.mdx +++ b/mintlify/get-started/cloud.mdx @@ -70,7 +70,7 @@ After adding someone: Configure access control - + Connect VCS (GitHub, GitLab) diff --git a/mintlify/vcs-integration/overview.mdx b/mintlify/gitops/overview.mdx similarity index 100% rename from mintlify/vcs-integration/overview.mdx rename to mintlify/gitops/overview.mdx diff --git a/mintlify/vcs-integration/release.mdx b/mintlify/gitops/release.mdx similarity index 100% rename from mintlify/vcs-integration/release.mdx rename to mintlify/gitops/release.mdx diff --git a/mintlify/introduction/use-cases.mdx b/mintlify/introduction/use-cases.mdx index eaac9590d..eb175b5e8 100644 --- a/mintlify/introduction/use-cases.mdx +++ b/mintlify/introduction/use-cases.mdx @@ -40,7 +40,7 @@ Bytebase is a unified database DevOps platform that transforms how teams collabo - Reduce database-related deployment delays by 90% **Key features:** -- [VCS Integration](/vcs-integration/overview) for GitOps workflows +- [VCS Integration](/gitops/overview) for GitOps workflows - [API-driven automation](/integrations/api/overview/) for custom CI/CD pipelines - Automated rollback and drift detection - Multi-environment progression (dev → staging → production) diff --git a/mintlify/onboarding/plan.mdx b/mintlify/onboarding/plan.mdx index 261ea9c3f..a0aca8153 100644 --- a/mintlify/onboarding/plan.mdx +++ b/mintlify/onboarding/plan.mdx @@ -92,7 +92,7 @@ The implementation duration depends on how many existing schema migration workfl Related features (in addition to Phase 1): - [Schema Synchronization](/change-database/synchronize-schema/) -- [GitOps](/vcs-integration/overview/) +- [GitOps](/gitops/overview/) - [Drift Detection](/change-database/drift-detection/) - [Batch Change](/change-database/batch-change/) - [Online Schema Migration (MySQL only)](/change-database/online-schema-migration-for-mysql/) diff --git a/mintlify/onboarding/poc.mdx b/mintlify/onboarding/poc.mdx index 1237d8767..a95699747 100644 --- a/mintlify/onboarding/poc.mdx +++ b/mintlify/onboarding/poc.mdx @@ -19,7 +19,7 @@ Check out [Roles and Permissions](/administration/roles). ## Configure Environment - [What is Environment](/concepts/data-model/#environment) -- [Rollout Policy](/administration/environment-policy/rollout-policy/) +- [Rollout Policy](/change-database/environment-policy/rollout-policy/) - [SQL Review Policy](/sql-review/review-policy/) ## Configure Instance @@ -41,7 +41,7 @@ Check out [Roles and Permissions](/administration/roles). - [Webhook Notification](/change-database/webhook/) - [Schema Drift Detection](/change-database/drift-detection/) - [Batch Change](/change-database/batch-change/) -- [GitOps](/vcs-integration/overview/) +- [GitOps](/gitops/overview/) ## SQL Editor diff --git a/mintlify/onboarding/sql-editor-data-access-control.mdx b/mintlify/onboarding/sql-editor-data-access-control.mdx index c53c2f046..75c1adf1e 100644 --- a/mintlify/onboarding/sql-editor-data-access-control.mdx +++ b/mintlify/onboarding/sql-editor-data-access-control.mdx @@ -19,7 +19,7 @@ Below we demonstrate a two environment setup, one for test and one for productio ### DDL and DML Execution -[Statement execution mode](/administration/environment-policy/overview/#statement-execution-mode) controls +[Statement execution mode](/change-database/environment-policy/overview/#statement-execution-mode) controls whether users can run DDL and DML directly in the SQL Editor at the environment level. | | Test | Prod | diff --git a/mintlify/snippets/database-permission-table.mdx b/mintlify/snippets/database-permission-table.mdx index e2bbf1d9d..311671ba0 100644 --- a/mintlify/snippets/database-permission-table.mdx +++ b/mintlify/snippets/database-permission-table.mdx @@ -3,7 +3,7 @@ | [Read](/sql-editor/run-queries/) | EXPLAIN | `sql.explain` | | | Query | `sql.select` | | | Export | `sql.export` | -| Write (subject to [execution mode](/administration/environment-policy/overview/#execution-mode)) | Mutation DML | `sql.dml` | +| Write (subject to [execution mode](/change-database/environment-policy/overview/#execution-mode)) | Mutation DML | `sql.dml` | | | DDL | `sql.ddl` | | [Admin](/sql-editor/admin-mode/) | Admin | `sql.admin` | | Request change for review | Create Issue | `issues.create` | diff --git a/mintlify/sql-editor/admin-mode.mdx b/mintlify/sql-editor/admin-mode.mdx index cc86b4b49..b2fe015ed 100644 --- a/mintlify/sql-editor/admin-mode.mdx +++ b/mintlify/sql-editor/admin-mode.mdx @@ -17,7 +17,7 @@ Click **Admin Mode** button to open a separate Admin Mode tab. Note that this is ![Admin Mode Button](/content/docs/sql-editor/admin-mode-button.webp) -In Admin Mode, you are not limited to run SELECT, DDL and DML change queries subject to the [statement execution policy](/administration/environment-policy/overview#statement-execution-mode), but also allowed to run database administration SQL statements such as SHOW, SET, GRANT, etc. +In Admin Mode, you are not limited to run SELECT, DDL and DML change queries subject to the [statement execution policy](/change-database/environment-policy/overview#statement-execution-mode), but also allowed to run database administration SQL statements such as SHOW, SET, GRANT, etc. ![Admin Mode](/content/docs/sql-editor/admin-mode.webp) diff --git a/mintlify/sql-review/gitops-ci.mdx b/mintlify/sql-review/gitops-ci.mdx index ba3882b56..5381beff7 100644 --- a/mintlify/sql-review/gitops-ci.mdx +++ b/mintlify/sql-review/gitops-ci.mdx @@ -2,7 +2,7 @@ title: CI Integration --- -Once you've set up the [GitOps Workflow](/vcs-integration/overview/), your SQL Review Policy will automatically be applied to all pull/merge requests. The results of the SQL review will appear as a comment. +Once you've set up the [GitOps Workflow](/gitops/overview/), your SQL Review Policy will automatically be applied to all pull/merge requests. The results of the SQL review will appear as a comment. ## GitHub diff --git a/mintlify/sql-review/review-policy.mdx b/mintlify/sql-review/review-policy.mdx index 1afde9587..2989de222 100644 --- a/mintlify/sql-review/review-policy.mdx +++ b/mintlify/sql-review/review-policy.mdx @@ -38,7 +38,7 @@ You can add or remove SQL Review rules per database engine to this policy. You can choose one of `Error`, `Warning` and `Disabled`. -Both `Warning` and `Error` will block the [automatic rollout](/administration/environment-policy/rollout-policy/#automatic-rollout) if configured. +Both `Warning` and `Error` will block the [automatic rollout](/change-database/environment-policy/rollout-policy/#automatic-rollout) if configured. ## Attach to Resources diff --git a/mintlify/tutorials/deploy-schema-migration.mdx b/mintlify/tutorials/deploy-schema-migration.mdx index 78f0935a4..987f84e5c 100644 --- a/mintlify/tutorials/deploy-schema-migration.mdx +++ b/mintlify/tutorials/deploy-schema-migration.mdx @@ -20,7 +20,7 @@ Bytebase offers **Community**, **Pro**, and **Enterprise** [plans](https://www.b ### Features covered -- Level 1 – [Automatic rollout (Rollout Policy)](/administration/environment-policy/rollout-policy/) (available in all plans) +- Level 1 – [Automatic rollout (Rollout Policy)](/change-database/environment-policy/rollout-policy/) (available in all plans) - Level 2 – [SQL Review](/sql-review/overview/) (available in all plans) - Level 3 – [Custom Approval](/administration/custom-approval/) (available in Enterprise) @@ -106,7 +106,7 @@ If you want the approval flow to be dynamic based on context, such as the type o You have learned how to deploy schema migrations using Bytebase. Explore more advanced capabilities: -- [GitOps](/vcs-integration/overview/): Observe Git pushes and trigger schema migrations. +- [GitOps](/gitops/overview/): Observe Git pushes and trigger schema migrations. - [Batch changes](/change-database/batch-change/): Change multiple databases in a single workflow. Join our [Discord channel](https://discord.com/invite/huyw7gRsyA) to discuss. diff --git a/mintlify/tutorials/how-to-synchronize-database-schemas.mdx b/mintlify/tutorials/how-to-synchronize-database-schemas.mdx index ed59b8257..85b0736d2 100644 --- a/mintlify/tutorials/how-to-synchronize-database-schemas.mdx +++ b/mintlify/tutorials/how-to-synchronize-database-schemas.mdx @@ -111,5 +111,5 @@ You've learned how to: ## Next steps - Learn about [batch changes](/change-database/batch-change/) -- Explore [GitOps integration](/vcs-integration/overview/) +- Explore [GitOps integration](/gitops/overview/) - Join our [Discord community](https://discord.gg/huyw7gRsyA) for support diff --git a/mintlify/tutorials/manage-environments-with-terraform.mdx b/mintlify/tutorials/manage-environments-with-terraform.mdx index 39be90be4..d8c38645e 100644 --- a/mintlify/tutorials/manage-environments-with-terraform.mdx +++ b/mintlify/tutorials/manage-environments-with-terraform.mdx @@ -189,7 +189,7 @@ resource "bytebase_setting" "environments" { ## Step 5 - Configure Environment Policies -Let's add rollout and data protection policies, for more details, see: [Environment Policy](/administration/environment-policy/overview) and [Rollout Policy](/administration/environment-policy/rollout-policy). +Let's add rollout and data protection policies, for more details, see: [Environment Policy](/change-database/environment-policy/overview) and [Rollout Policy](/change-database/environment-policy/rollout-policy). ### Rollout Policy diff --git a/next.config.js b/next.config.js index 36f356c82..12c17e126 100644 --- a/next.config.js +++ b/next.config.js @@ -77,17 +77,22 @@ module.exports = { }, { source: '/docs/tutorials/database-cicd-best-practice-with-gitlab', - destination: '/docs/vcs-integration/overview', + destination: '/docs/gitops/overview', permanent: true, }, { source: '/docs/tutorials/database-cicd-best-practice-with-bitbucket', - destination: '/docs/vcs-integration/overview', + destination: '/docs/gitops/overview', permanent: true, }, { source: '/docs/vcs-integration/add-gitops-connector', - destination: '/docs/vcs-integration/overview', + destination: '/docs/gitops/overview', + permanent: true, + }, + { + source: '/docs/vcs-integration/:path*', + destination: '/docs/gitops/overview', permanent: true, }, { diff --git a/public/content/blog/stop-using-navicat/bytebase-vcs-integration.webp b/public/content/blog/stop-using-navicat/bytebase-gitops.webp similarity index 100% rename from public/content/blog/stop-using-navicat/bytebase-vcs-integration.webp rename to public/content/blog/stop-using-navicat/bytebase-gitops.webp diff --git a/src/lib/glossary-data.ts b/src/lib/glossary-data.ts index e1892eead..cc61bdb0c 100644 --- a/src/lib/glossary-data.ts +++ b/src/lib/glossary-data.ts @@ -209,7 +209,7 @@ export const GLOSSARY_LIST: GlossaryLetterSet[] = [ Thus the database schema change is managed in a very similar fashion as code. This workflow is considered superior than the classic UI based SQL review workflow. However, it requires a bit more setup and engineering discipline. Bytebase supports this workflow and helps ease the onboarding and ongoing management of using this workflow.`, - reference: 'https://www.bytebase.com/docs/vcs-integration/overview', + reference: 'https://www.bytebase.com/docs/gitops/overview', tagList: ['General', 'Bytebase'], }, { diff --git a/src/lib/route.ts b/src/lib/route.ts index 91bce326f..c500b2506 100644 --- a/src/lib/route.ts +++ b/src/lib/route.ts @@ -68,7 +68,7 @@ const Route = { DOCS_AUDIT_LOG: `${DOCS_ROOT}/security/audit-log`, DOCS_INDEX_ADVISOR: `${DOCS_ROOT}/slow-query/overview`, DOCS_DRIFT_DETECTION: `${DOCS_ROOT}/change-database/drift-detection`, - DOCS_VCS_INTEGRATION: `${DOCS_ROOT}/vcs-integration/overview`, + DOCS_VCS_INTEGRATION: `${DOCS_ROOT}/gitops/overview`, DOCS_BATCH_CHANGE: `${DOCS_ROOT}/change-database/batch-change`, DOCS_ONLINE_SCHEMA_CHANGE: `${DOCS_ROOT}/change-database/online-schema-migration-for-mysql`, DOCS_RBAC: `${DOCS_ROOT}/concepts/roles-and-permissions`,