Skip to content

Commit d83edc9

Browse files
committed
docs: guideline on how to organize projects
1 parent 47775cc commit d83edc9

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

content/docs/concepts/data-model.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,12 @@ A list of databases usually having the same schema structure. Examples like per-
5757

5858
## Project
5959

60+
<HintBlock type="info">
61+
62+
[How to Organize Projects?](/docs/onboarding/#how-to-organize-projects)
63+
64+
</HintBlock>
65+
6066
`Project` is a logic unit to model a team effort. It's similar to the project concept in other dev tools such as Jira, GitLab. `Project` is the container to group logically related `Databases`, `Issues` and `Users` together. In Bytebase, A `Database` or an `Issue` always belongs to a single `Project`. `Project` is also the peering entity with the VCS repository to setup [GitOps workflow](/docs/vcs-integration/add-gitops-connector).
6167

6268
Most of the time, `Developers` work with the `Project`.

content/docs/onboarding.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,17 @@ Related features (in addition to Phase 1):
9898
- [Changelist](/docs/changelist/)
9999
- [Online Schema Migration (MySQL only)](/docs/change-database/online-schema-migration-for-mysql/)
100100

101+
## How to Organize Projects
102+
103+
Bytebase has a `Project` concept to group logically related `Databases`, `Issues` and `Users` together. This
104+
is similar to the project concept in other tools such as Jira, GitLab.
105+
106+
We recommend you to put databases sharing the same schema structure into the same project. For example,
107+
if you have a multi-tenant SaaS application, you can put all the tenant databases into the same project.
108+
109+
If you have a single team managing databases with different schema structure, you can create a project for each
110+
schema structure, and create a [user group](/docs/administration/user-groups/) for the team. You then grant the project role to the user group.
111+
101112
## Configuration Guideline
102113

103114
Bytebase provides settings at the workspace, environment, project levels. Below we provide a sample configuration settings for a typical scenarios:

0 commit comments

Comments
 (0)