Skip to content

Commit aa2dc08

Browse files
GitHub repo branch settings (#1778)
* Document GitHub repository branch settings + Improve a bit the existing content * Improve explanations * Move all branch and repo changes to the right page (project settings instead of account settings) * Update screenshot * Add project deletion section to complete the General tab documentation * Update screenshot
1 parent 1c1891e commit aa2dc08

File tree

2 files changed

+30
-8
lines changed

2 files changed

+30
-8
lines changed

docusaurus/docs/cloud/projects/settings.md

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,43 @@ sidebar_position: 2
88

99
# Project Settings
1010

11-
The **Project Settings** page enables you to manage the configuration and settings for this project. It has the following tabs:
11+
The *Project Settings* page enables you to manage the configuration and settings for of Strapi Cloud project. There are 4 tabs available: *General*, *Domains*, *Variables* and *Billing*.
1212

1313
## General
1414

15-
The *General* tab enables you to check and update the following details for the project:
15+
The *General* tab enables you to check and update the following options for the project:
1616

17-
* **Project name**: The name of your Strapi app, used to identify the project on the Cloud Dashboard, Strapi CLI, and deployment URLs. Cannot be edited after creation.
18-
* **Production branch**: The branch of the linked repository to use for production deployments. Cannot be edited after creation.
19-
* **Base directory**: The directory where your Strapi app is located in the repository. This is useful if you have multiple Strapi apps in the same repository or if you have a monorepo. Cannot be edited after creation.
20-
* **Connected GitHub repository**: The Git repository linked to the project. Cannot be edited after creation.
21-
* **Delete project**: This will ***permanently and irreversibly*** delete the project and all its associated data.
22-
* **Debug info**: Displays the internal project name for your application. This is useful for support purposes.
17+
- Details: to modify the name of your Strapi Cloud project, used to identify the project on the Cloud Dashboard, Strapi CLI, and deployment URLs. The project name cannot be edited after creation.
18+
- Connected Git repository: to change the branch of the GitHub repository used for your project (see [Modifying GitHub repository branch](#modifying-github-repository-branch)).
19+
- Selected region: to see the hosting region of the project.
20+
- Debug info: to see the internal project name for the project. This is useful for support purposes.
21+
- Delete project: to permanently delete your Strapi Cloud project (see [Deleting Strapi Cloud project](#deleting-strapi-cloud-project)).
2322

2423
![Project settings](/img/assets/cloud/settings.png)
2524

25+
### Modifying GitHub repository branch
26+
27+
The GitHub repository branch and base directory for a Strapi Cloud project are by default chosen at the creation of the project (see [Creating a project](/cloud/getting-started/deployment)). Both can afterwards be edited via the account settings.
28+
29+
1. In the *Connected Git repository* section of the *General* tab, click on the **Edit** button.
30+
2. In the *Edit Git settings* dialog, edit the available options of your choice:
31+
32+
| Setting name | Instructions |
33+
| --------------- | ------------------------------------------------------------------------ |
34+
| Selected branch | Choose a branch from the drop-down list. |
35+
| Base directory | Write the path of the base directory in the textbox. |
36+
| Deploy the project on every commit pushed to this branch | Check the box to automatically trigger a new deployment whenever a new commit is pushed to the selected branch. |
37+
38+
3. Click on the **Save** button.
39+
40+
### Deleting Strapi Cloud project
41+
42+
You can delete any Strapi Cloud project, but it will be permanent and irreversible. Associated domains, deployments and data will be deleted as well and the subscription for the project will automatically be cancelled.
43+
44+
1. In the *Delete project* section of the *General* tab, click on the **Delete project** button.
45+
2. In the dialog, type `DELETE` in the textbox.
46+
3. Confirm the deletion of your project by clicking on the **Delete** button.
47+
2648
## Domains
2749

2850
The *Domains* tab enables you to manage domains and connect new ones.
272 KB
Loading

0 commit comments

Comments
 (0)