For the complete documentation index, see llms.txt. This page is also available as Markdown.

Project

Definition

A project is a container of environments and architectures to which teams have access with specific permissions.

💡Think of a project as an upper level folder.

By default, members don't have direct permissions on projects unless the admin grants them access to.


Create a new project

To create a new project:

  1. Click on the Create project button.

  1. You will then go through a project creation wizard comprising of three steps:

  • First step: Here, you will set up the name, description and environments of the new project.

Brainboard creates 5 environments by default: Production, Staging, Development, Test and QA.

You can also add any custom environment as well

  • Second step: Here, you will need to assign teams to roles. You can do that by dragging and dropping each team into the corresponding role.

  • Third step: Here, you can view the summary of the new project: name, description, environment and the teams assigned to this project with their roles.

  1. Click the Create project button to save your project details.

Upon clicking the Create project button, the new project's details will be saved, and you will be navigated to the project settings page, where you can view the project details as well as edit it.

View the project's information

To view the information on a specific project:

  1. Click on the + icon next to the project name, and the project's details will be expanded, such as:

  • Name of the project.

  • Teams that have access to this project with their respective roles.

  • The environments of the project.

Alternatively, you can click on the ellipsis icon next to the project name, and then select the View details option from the dropdown menu.

Click the cross x icon to collapse the project details view.

Edit project information

To edit the information on a project:

  1. Click on the ellipsis icon next to the project name, and then select the Edit project details option from the dropdown menu.

  1. You can alter the project name, description, and environments.

  2. Click on the Save changes button in the top right corner of the Edit project details slide-out panel to save the new information.

Edit project roles

By default, the following four types of roles are available for a Brainboard project:

  • Admin

  • Designer

  • Operator

  • Guest

To assign a role to a team:

  1. Click on the ellipsis icon next to the project name, and then select the Assign teams option from the dropdown menu.

  1. You can assign a role to a team as you did when you created a new project - simple drag and drop a team to the specific role that you want to assign to it.

  2. Click on the Update button to save the new information about the project.

Delete project

To delete a project:

  1. Click on the ellipsis icon next to the project name, and then select the Delete project option from the dropdown menu.

  2. You'll be asked to confirm the deletion. To do so, type the word "DELETE" in the input field, and click the Yes, delete project button.

If there is only one project in your account, it cannot be deleted since your account needs at least one project.

Last updated