Skip to content

Commit 3b3f015

Browse files
committed
Merge branch 'main' of github.com:strapi/documentation
2 parents 3a603b8 + e2e42f7 commit 3b3f015

21 files changed

+167
-16
lines changed

docusaurus/docs/cloud/account/settings.md

Lines changed: 50 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,69 @@ description: View and manage your projects on Strapi Cloud.
55
canonicalUrl: https://docs.strapi.io/cloud/account/settings.html
66
---
77

8-
# Account Settings
8+
# Account profile
99

10-
The **Account Settings** page enables you to manage your account details and preferences. There are three sections available:
10+
The *Profile* page enables you to manage your account details and preferences. It is accessible by clicking on your profile picture, on the top right hand corner of the interface, and **Profile**. There are 3 tabs available in the *Profile* interface: *General*, *Preferences* and *Billing*.
1111

1212
## General
1313

14-
The **General** tab enables you to edit the following details for your account:
14+
The *General* tab enables you to edit the following details for your account profile:
1515

16-
* **Name**: The name associated with your account.
16+
- Details: to see the name associated with your account, which is based on the one defined in your GitHub account.
17+
- Delete account: to permanently delete your Strapi Cloud account (see [Deleting Strapi Cloud account](#deleting-strapi-cloud-account)).
18+
19+
<ThemedImage
20+
alt="General tab of Profile page"
21+
sources={{
22+
light: '/img/assets/cloud/account-deletion.png',
23+
dark: '/img/assets/cloud/account-deletion_DARK.png',
24+
}}
25+
/>
26+
27+
<!--
28+
### Modifying profile details
29+
30+
1. In the *Details* section of the *General* tab, modify the information of your choice:
31+
32+
| Setting name | Instructions |
33+
| --------------- | ------------------------------------------------------------------------ |
34+
| Name | Write your full name in the textbox. |
35+
| Email | Write your complete email address in the textbox. |
36+
37+
2. Click on the **Save** button.
38+
-->
39+
40+
### Deleting Strapi Cloud account
41+
42+
You can delete your Strapi Cloud account, but it will be permanent and irreversible. All associated projects and their data will be deleted as well and the subscriptions for the projects will automatically be canceled.
43+
44+
1. In the *Delete account* section of the *General* tab, click on the **Delete account** button.
45+
2. In the dialog, type `DELETE` in the textbox.
46+
3. Confirm the deletion of your account by clicking on the **Delete** button.
1747

1848
## Preferences
1949

20-
The **Preferences** tab enables you to edit the following details for your account:
50+
The *Preferences* tab enables you to choose the appearance of your Strapi Cloud dashboard: either the Light or Dark theme.
2151

22-
* **Appearance**: Choose between the **Light** and **Dark** themes.
52+
<ThemedImage
53+
alt="Preferences tab of Profile page"
54+
sources={{
55+
light: '/img/assets/cloud/account-preferences.png',
56+
dark: '/img/assets/cloud/account-preferences_DARK.png',
57+
}}
58+
/>
2359

2460
## Billing
2561

26-
The **Billing** tab displays your billing information and enables you to update your payment method.
62+
The *Billing* tab displays your billing information and enables you to update your payment method.
2763

28-
![Account billing settings](/img/assets/cloud/account-billing.png)
64+
<ThemedImage
65+
alt="Billing tab of Profile page"
66+
sources={{
67+
light: '/img/assets/cloud/account-billing2.png',
68+
dark: '/img/assets/cloud/account-billing2_DARK.png',
69+
}}
70+
/>
2971

3072
### Managing subscriptions
3173

docusaurus/docs/cloud/getting-started/deployment.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,16 @@ Before you can deploy your Strapi application on Strapi Cloud, you need to have
3737
You will be shown a **plan selection** dialog.
3838
This will allow you to select the most relevant plan for your project. Refer to [Pricing](https://strapi.io/pricing-cloud) for more information.
3939

40-
![Plan selection page](/img/assets/cloud/plan-selection.png)
40+
<ThemedImage
41+
alt="Plan selection page"
42+
sources={{
43+
light: '/img/assets/cloud/plan-selection.png',
44+
dark: '/img/assets/cloud/plan-selection_DARK.png',
45+
}}
46+
/>
4147

4248
:::note
4349
Strapi Cloud offers a free trial for only one project.
44-
4550
If you have already used a free trial for a previous project, the option will no longer appear in the plan selection.
4651
:::
4752

@@ -67,8 +72,19 @@ Before you can deploy your Strapi application on Strapi Cloud, you need to have
6772
* **Project name**: The name of your Strapi app, this is fetched from the repository name but can be edited. It is automatically converted to slug format (`my-strapi-app`).
6873
* **GitHub branch**: The default branch to use for this deployment. This uses the [default branch](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch) of the repository but can be changed via the drop-down.
6974
* **Deploy on push**: When enabled, this will automatically deploy the latest changes from the selected branch. When disabled, you will need to manually deploy the latest changes.
75+
* **Region**: The geographic location of the servers where your Strapi application is hosted. Selected region can either be USA in North America (default) or Amsterdam in Europe.
76+
77+
:::note
78+
The GitHub branch and "Deploy on push" settings can be modified afterwards through the project's setting, however the project name and hosting region setting can only be chosen during the creation of the project (see [Project Settings](/cloud/projects/settings)).
79+
:::
7080

71-
![Project Setup](/img/assets/cloud/setup.png)
81+
<ThemedImage
82+
alt="Project Setup"
83+
sources={{
84+
light: '/img/assets/cloud/setup.png',
85+
dark: '/img/assets/cloud/setup_DARK.png',
86+
}}
87+
/>
7288

7389
6. (**Optional**) Select **Show Advanced Settings** to configure the following options:
7490
* **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.
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
title: Collaboration
3+
displayed_sidebar: cloudSidebar
4+
description: Share your projects on Strapi Cloud to collaborate with others.
5+
canonicalUrl: https://docs.strapi.io/cloud/projects/collaboration.md
6+
sidebar_position: 1
7+
---
8+
9+
# Collaboration on projects
10+
11+
Projects are created by a user via their Strapi Cloud account, which is linked to their GitHub account. Strapi Cloud users can share their projects to anyone else, so these new users can have access to the Cloud dashboard and collaborate on that project, without the project owner to ever have to share their GitHub credentials.
12+
13+
Users invited to collaborate on a project, called maintainers, do not have the same permissions as the project owner. Contrary to the project owner, maintainers:
14+
15+
- Cannot share the project themselves to someone else
16+
- Cannot delete the project from the project settings
17+
- Cannot access the *Billing* section of project settings
18+
19+
## Sharing a project
20+
21+
<ThemedImage
22+
alt="Share button and avatar"
23+
sources={{
24+
light: '/img/assets/cloud/collaboration-projectview.png',
25+
dark: '/img/assets/cloud/collaboration-projectview_DARK.png',
26+
}}
27+
/>
28+
29+
To invite a new maintainer to collaborate on a project:
30+
31+
1. Go to the *Overview* tab of your project dashboard.
32+
2. Click on the **Share** button in the top right hand corner.
33+
3. In the *Share [project name]* dialog, type the email address of the person to invite in the textbox. A dropdown indicating "Invite [email address]" should appear.
34+
4. Click on the dropdown: the email address should be displayed in a purple box right below the textbox.
35+
5. (optional) Repeat steps 3 and 4 to invite more people. Email addresses can only entered one by one but invites can be sent to several email addresses at the same time.
36+
6. Click on the **Send** button.
37+
38+
New maintainers will be sent an email containing a link to click on to join the project. Once a project is shared, avatars representing the maintainers will be displayed in the project dashboard next to the **Share** button, to see how many maintainers collaborate on that project and who they are.
39+
40+
:::tip
41+
Avatars use GitHub profile pictures, but for pending users only initials will be displayed until the activation of the maintainer account. You can hover over an avatar to display the full name of the maintainer.
42+
:::
43+
44+
## Managing maintainers
45+
46+
From the *Share [project name]* dialog accessible by clicking on the **Share** button of a project dashboard, projects owners can view the full list of maintainers who have been invited to collaborate on the project. From there, it is possible to see the current status of each maintainer and to manage them.
47+
48+
<ThemedImage
49+
alt="Share button and avatar"
50+
sources={{
51+
light: '/img/assets/cloud/collaboration-dialog.png',
52+
dark: '/img/assets/cloud/collaboration-dialog_DARK.png',
53+
}}
54+
/>
55+
56+
Maintainers whose full name is displayed are users who did activate their account following the invitation email. If however there are maintainers in the list whose email address is displayed, it means they haven't activated their accounts and can't access the project dashboard yet. In that case, a status should be indicated right next to the email address to explain the issue:
57+
58+
- Pending: the invitation email has been sent but the maintainer hasn't acted on it yet.
59+
- Expired: the email has been sent over 72 hours ago and the invitation expired.
60+
61+
For Expired statuses, it is possible to send another invitation email by clicking on the **Manage** button, then **Resend invite**.
62+
63+
### Revoking maintainers
64+
65+
To revoke a maintainer's access to the project dashboard:
66+
67+
1. Click on the **Share** button in the project dashboard.
68+
2. In the list of *People with access*, find the maintainer whose access to revoke and click on the **Manage** button.
69+
3. Click on the **Revoke** button.
70+
4. In the confirmation dialog, click again on the **Revoke** button.
71+
72+
The revoked maintainer will completely stop having access to the project dashboard.
73+
74+
:::note
75+
Maintainers whose access to the project has been revoked do not receive any email or notification.
76+
:::

docusaurus/docs/cloud/projects/settings.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@ The *Project Settings* page enables you to manage the configuration and settings
1414

1515
The *General* tab enables you to check and update the following options for the project:
1616

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.
17+
- Details: to see the name of your Strapi Cloud project, used to identify the project on the Cloud Dashboard, Strapi CLI, and deployment URLs. The project name is set at project creation (see [Deployment](/cloud/getting-started/deployment)) and cannot be modified afterwards.
1818
- 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.
19+
- Selected region: to see the hosting region of the project, meaning the geographical location of the servers where the project and its data and resources are stored. The hosting region is set at project creation (see [Deployment](/cloud/getting-started/deployment)) and cannot be modified afterwards.
2020
- Debug info: to see the internal project name for the project. This is useful for support purposes.
2121
- Delete project: to permanently delete your Strapi Cloud project (see [Deleting Strapi Cloud project](#deleting-strapi-cloud-project)).
2222

2323
![Project settings](/img/assets/cloud/settings.png)
2424

2525
### Modifying GitHub repository branch
2626

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.
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 project's settings.
2828

2929
1. In the *Connected Git repository* section of the *General* tab, click on the **Edit** button.
3030
2. In the *Edit Git settings* dialog, edit the available options of your choice:

docusaurus/docs/dev-docs/configurations/environment.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,10 @@ Strapi provides the following environment variables:
2222
| `BROWSER` | Open the admin panel in the browser after startup | `Boolean` | `true` |
2323
| `ENV_PATH` | Path to the file that contains your environment variables | `String` | `'./.env'` |
2424
| `STRAPI_PLUGIN_I18N_INIT_LOCALE_CODE` <br/><br/>_Optional_ | Initialization locale for the application, if the [Internationalization (i18n) plugin](/dev-docs/plugins/i18n) is installed and enabled on Content-Types (see [Configuration of i18n in production environments](/dev-docs/plugins/i18n#configuration-of-the-default-locale)) | `String` | `'en'` |
25+
| `STRAPI_ENFORCE_SOURCEMAPS` | Forces the bundler to emit source-maps, which is helpful for debugging errors in the admin app. | `boolean` | `false` |
2526
| `FAST_REFRESH` | Use [react-refresh](https://github.com/pmmmwh/react-refresh-webpack-plugin) to enable "Fast Refresh" for near-instant feedback while developing the Strapi admin panel. | `boolean` | `true` |
2627

28+
2729
:::tip
2830
Prefixing an environment variable name with `STRAPI_ADMIN_` exposes the variable to the admin front end (e.g., `STRAPI_ADMIN_MY_PLUGIN_VARIABLE` is accessible through `process.env.STRAPI_ADMIN_MY_PLUGIN_VARIABLE`).
2931
:::

docusaurus/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "strapi-docs",
3-
"version": "4.12.1",
3+
"version": "4.12.4",
44
"private": true,
55
"scripts": {
66
"docusaurus": "docusaurus",

docusaurus/sidebars.js

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -547,6 +547,14 @@ const sidebars = {
547547
updated: true,
548548
},
549549
},
550+
{
551+
type: 'doc',
552+
label: 'Collaboration',
553+
id: 'cloud/projects/collaboration',
554+
customProps: {
555+
new: true,
556+
},
557+
},
550558
{
551559
type: 'doc',
552560
label: 'Notifications',
@@ -559,7 +567,14 @@ const sidebars = {
559567
collapsed: false,
560568
label: 'Account Management',
561569
items: [
562-
'cloud/account/settings',
570+
{
571+
type: 'doc',
572+
label: 'Account Settings',
573+
id: 'cloud/account/settings',
574+
customProps: {
575+
updated: true,
576+
},
577+
},
563578
]
564579
},
565580
{
269 KB
Loading
270 KB
Loading
161 KB
Loading

0 commit comments

Comments
 (0)