You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Reviewed & complete version of Strapi Cloud documentation (#1961)
* Rework TOC titles
* Separate account/sessing into 2 pages
* Start working the Projects section
* Rework and complete Usage and Billing page
* Rework Projects overview page
* Fix links in Usage and Billing
* Separate deployment and deploy history in 2 pages and rework content in both
* Move deployment pages to a new Deployments section in the TOC
* Review Overview and Settings pages
* Review or write content for deploys docs and runtime logs
* Delete custom plan from Billing & Usage page
* Mention GitLab where it was forgotten
* Improve Notifications page
* Fix/improve all projects management pages
* Fix/improve all deployments pages
* Fix/improve Account settings page
* Update all screenshots
* Fix broken links
* Fix header link
* Remove useless link in Project settings
Co-authored-by: Pierre Wizla <[email protected]>
* Update one more screenshot + Delete useless comments
* Add icons
* Delete More.svg in static
* Delete more.svg again
* Add More.svg
* Fix icon name in releases
* Add Node version feature in Project settings + Update screenshot
* Add forgotten word in deploy logs
---------
Co-authored-by: Pierre Wizla <[email protected]>
Co-authored-by: Pierre Wizla <[email protected]>
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*.
11
-
12
-
## General
13
-
14
-
The *General* tab enables you to edit the following details for your account profile:
15
-
16
-
- Details: to see the name associated with your account.
17
-
- Connected accounts: to manage Google and GitHub accounts connected with your Strapi Cloud account.
18
-
- Delete account: to permanently delete your Strapi Cloud account (see [Deleting Strapi Cloud account](#deleting-strapi-cloud-account)).
19
-
20
-
<!-- TODO: replace with screenshot with connected accounts -->
You can connect a Google account and a GitHub account to your Strapi Cloud account. The _Connected accounts_ section lists accounts that are currently connected to your Strapi Cloud account. From there you can also connect a new Google or GitHub account if one is not already connected.
33
-
34
-
To connect a new Google or GitHub account to your Strapi Cloud account, click on the **Connect account** button and follow the next steps on the corresponding website.
35
-
36
-
You can also click on the three dots button of a connected account and click on the "Manage on" button to manage your GitHub or Google account directly on the corresponding website.
37
-
38
-
### Deleting Strapi Cloud account
39
-
40
-
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.
41
-
42
-
1. In the *Delete account* section of the *General* tab, click on the **Delete account** button.
43
-
2. In the dialog, type `DELETE` in the textbox.
44
-
3. Confirm the deletion of your account by clicking on the **Delete** button.
45
-
46
-
## Preferences
47
-
48
-
The *Preferences* tab enables you to choose the appearance of your Strapi Cloud dashboard: either the Light or Dark theme.
Through the *Profile* page, accessible by clicking on your profile picture on the top right hand corner of the interface then clicking on **Profile**, you can view and modify the billing details set for the account. This information will by default be reused for every new project created with your Strapi Cloud account.
59
11
60
12
The *Billing* tab displays your billing information and enables you to update your payment method.
61
13
@@ -67,7 +19,7 @@ The *Billing* tab displays your billing information and enables you to update yo
67
19
}}
68
20
/>
69
21
70
-
###Managing subscriptions
22
+
## Managing subscriptions
71
23
72
24
Using the **Manage subscriptions** button, you can view and manage your subscriptions, account and billing information, and payment method.
73
25
@@ -91,7 +43,7 @@ Using the **Manage subscriptions** button, you can view and manage your subscrip
91
43
}}
92
44
/>
93
45
94
-
###Edit subscription
46
+
## Edit subscription
95
47
96
48
From the subscription management modal, you can view and modify any current subscription.
97
49
@@ -109,7 +61,7 @@ From the subscription management modal, you can view and modify any current subs
109
61
4. If you want to change plan (e.g. from Pro plan to Team plan), click on **Change** and select a new plan.
110
62
5. Confirm your modifications by clicking on the **Update Subscription** button at the bottom of the modal.
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**.
11
+
12
+
There are 3 tabs available in the *Profile* interface: [*General*](#general), [*Preferences*](#preferences) and *Billing* (the latter is documented in the [Account billing details](/cloud/account/account-billing) section of this documentation).
13
+
14
+
## General
15
+
16
+
The *General* tab enables you to edit the following details for your account profile:
17
+
18
+
- Details: to see the name associated with your account.
19
+
- Connected accounts: to manage Google, GitHub and GitLab accounts connected with your Strapi Cloud account (see [Managing connected accounts](#managing-connected-accounts)).
20
+
- Delete account: to permanently delete your Strapi Cloud account (see [Deleting Strapi Cloud account](#deleting-strapi-cloud-account)).
You can connect a Google, GitLab and GitHub account to your Strapi Cloud account. The _Connected accounts_ section lists accounts that are currently connected to your Strapi Cloud account. From there you can also connect a new Google, GitLab and GitHub account if one is not already connected.
33
+
34
+
To connect a new Google, GitLab or GitHub account to your Strapi Cloud account, click on the **Connect account** button and follow the next steps on the corresponding website.
35
+
36
+
You can also click on the three dots button of a connected account and click on the "Manage on" button to manage your GitHub, GitLab or Google account directly on the corresponding website.
37
+
38
+
### Deleting Strapi Cloud account
39
+
40
+
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.
41
+
42
+
1. In the *Delete account* section of the *General* tab, click on the **Delete account** button.
43
+
2. In the dialog, type `DELETE` in the textbox.
44
+
3. Confirm the deletion of your account by clicking on the **Delete** button.
45
+
46
+
## Preferences
47
+
48
+
The *Preferences* tab enables you to choose the appearance of your Strapi Cloud dashboard: either the Light or Dark theme.
Copy file name to clipboardExpand all lines: docusaurus/docs/cloud/getting-started/usage-billing.md
+20-21Lines changed: 20 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,48 +6,47 @@ sidebar_position: 3
6
6
7
7
# Usage & Billing
8
8
9
-
This page contains general information related to the usage and billing of your Strapi Cloud account and applications. Strapi Cloud offers a free 7-day trial for all new accounts and two paid plans: **Pro** and **Team**.
9
+
This page contains general information related to the usage and billing of your Strapi Cloud account and projects.
10
10
11
-
The usage-based pricing for Strapi Cloud is based on the following criteria and limits:
11
+
Strapi Cloud offers a free 14 days trial for all new accounts, and 2 paid plans: Pro and Team (see [Pricing page](https://strapi.io/pricing-cloud)). The usage-based pricing for Strapi Cloud is based on the following criteria and limits:
-**Seats**are the maximum number of users that can access the Strapi Admin Panel.
26
-
-**Database Entries** are the number of entries in your database.
27
-
-**Assets Storage** is the amount of storage used by your assets.
28
-
-**Assets Bandwidth** is the amount of bandwidth used by your assets.
29
-
-**API Requests**are the number of requests made to your APIs. This includes requests made to the GraphQL and REST APIs.
30
-
-**Releases** are the maximum number of pending [releases](/user-docs/releases/introduction) that can be created.
23
+
:::strapi Additional information on Strapi Cloud features
24
+
- Seats are the maximum number of users that can access the Strapi admin panel.
25
+
-Database entries are the number of entries in your database.
26
+
-Assets storage is the amount of storage used by your assets.
27
+
- Assets bandwidth is the amount of bandwidth used by your assets.
28
+
-API requests are the number of requests made to your APIs. This includes requests made to the GraphQL and REST APIs.
29
+
-Releases are the maximum number of pending [releases](/user-docs/releases/introduction) that can be created.
30
+
:::
31
31
32
32
## Seats management
33
33
34
-
Seats represent the maximum number of users that can access the Strapi Admin Panel. Each plan comes with a default number of seats.
35
-
36
-
You can add more seats either by upgrading to a higher plan, or manually adding individual seats as desired. Seat can be added from the **Account Settings** -> **Manage Subscription** menu as detailed [here](../account/settings#managing-subscriptions).
34
+
Seats represent the maximum number of users that can access the Strapi admin panel. Each plan comes with a default number of seats.
37
35
38
-
### Maximum seats
36
+
You can add more seats either by upgrading to a higher plan, or manually adding individual seats as desired. Seats can be added from the **Account Settings** (see [Edit subscription](/cloud/account/account-billing#edit-subscription)).
39
37
40
-
Each plan has a maximum number of seats that can be added. The maximum number of seats for each plan is as follows:
38
+
There is however a maximum number of seats that can be added per plan:
41
39
42
40
| Plan | Maximum Seats |
43
41
| --- | --- |
44
42
|**Free Trial**| 10 |
45
43
|**Pro**| 30 |
46
44
|**Team**| 50 |
45
+
47
46
48
47
## Billing
49
48
50
-
Billing is based on the usage of your Strapi Cloud account and applications. You will be billed monthly for the usage of your account and applications. You can view your usage and billing information in the [Billing](https://cloud.strapi.io/profile/billing) section of your Strapi Cloud account.
49
+
Billing is based on the usage of your Strapi Cloud account and projects. You will be billed monthly for the usage of your account and applications. You can view your usage and billing information in the [Billing](https://cloud.strapi.io/profile/billing) section of your Strapi Cloud account.
51
50
52
51
### Overages
53
52
@@ -58,7 +57,7 @@ For example, if you exceed the 500GB limit in asset bandwidth of the Pro plan, y
58
57
Overages are charged according to the following rates:
59
58
60
59
| Feature | Rate |
61
-
|:--- | ---:|
60
+
| --- | --- |
62
61
|**API Requests**| $1.50 / 25k requests |
63
62
|**Asset Bandwidth**| $25.00 / 100GB |
64
63
|**Asset Storage**| $2.00/GB per month |
@@ -67,7 +66,7 @@ Overages are charged according to the following rates:
67
66
68
67
Projects may end up in a **Suspended** state for various reasons, including: not paying the invoice, exceeding the limits of your free trial plan, or violating the [terms of service](https://strapi.io/cloud-legal).
69
68
70
-
If your project is suspended, you will no longer be able to access the application or trigger new deployments. You will also be unable to access the Strapi Admin Panel.
69
+
If your project is suspended, you will no longer be able to access the application or trigger new deployments. You will also be unable to access the Strapi admin panel.
71
70
72
71
You can view the status of your project in the [Projects](https://cloud.strapi.io/projects) section of your Strapi Cloud account and you will be notified by email.
73
72
@@ -77,7 +76,7 @@ If you do not resolve the issue within 10 days, your suspended project will be d
77
76
78
77
#### Project suspension after subscription cancellation
79
78
80
-
If you don't pay the invoice, the subscription of your project will automatically be cancelled and the project will be suspended. You can reactivate the subscription through the billing modal (see [Edit subscription](https://docs.strapi.io/cloud/account/settings#edit-subscription)).
79
+
If you don't pay the invoice, the subscription of your project will automatically be cancelled and the project will be suspended. You can reactivate the subscription through the billing modal (see [Edit subscription](/cloud/account/account-billing#edit-subscription)).
81
80
82
81
1. Log into the billing modal and go to the *Subscription details* of the subscription associated with the suspended project. You should see a warning message confirming that the subscription was canceled for the following reason: "Not Paid".
83
82
2. Go back to the homepage of the billing modal, listing subscriptions and billing options.
Copy file name to clipboardExpand all lines: docusaurus/docs/cloud/projects/collaboration.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ sidebar_position: 1
8
8
9
9
# Collaboration on projects
10
10
11
-
Projects are created by a user via their Strapi Cloud 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 credentials.
11
+
Projects are created by a user via their Strapi Cloud account. Strapi Cloud users can share their projects to anyone else, so these new users can have access to the project dashboard and collaborate on that project, without the project owner to ever have to share their credentials.
12
12
13
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
14
@@ -28,17 +28,17 @@ Users invited to collaborate on a project, called maintainers, do not have the s
28
28
29
29
To invite a new maintainer to collaborate on a project:
30
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.
31
+
1.From the *Projects* page, click on the project of your choice to be redirected to its dashboard.
32
+
2. Click on the **Share** button located in the dashboard's header.
33
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
34
4. Click on the dropdown: the email address should be displayed in a purple box right below the textbox.
35
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
36
6. Click on the **Send** button.
37
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.
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's header, next to the **Share** button, to see how many maintainers collaborate on that project and who they are.
39
39
40
40
:::tip
41
-
Avatars use GitHubor Google 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.
41
+
Avatars use GitHub, Google or GitLab 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
42
:::
43
43
44
44
## Managing maintainers
@@ -64,7 +64,7 @@ For Expired statuses, it is possible to send another invitation email by clickin
64
64
65
65
To revoke a maintainer's access to the project dashboard:
66
66
67
-
1. Click on the **Share** button in the project dashboard.
67
+
1. Click on the **Share** button in the project dashboard's header.
68
68
2. In the list of *People with access*, find the maintainer whose access to revoke and click on the **Manage** button.
69
69
3. Click on the **Revoke** button.
70
70
4. In the confirmation dialog, click again on the **Revoke** button.
For each Strapi Cloud project, you can access the history of all deployments that occured and their details including build and deploy logs. This information is available in the *Deploys* tab, located in the header of any chosen project.
12
+
13
+
## Viewing deploy history
14
+
15
+
In the *Deploys* tab is displayed a chronological list of cards with the details of all historical deployments for your project.
16
+
17
+
<ThemedImage
18
+
alt="Project deploys"
19
+
sources={{
20
+
light: '/img/assets/cloud/deploys.png',
21
+
dark: '/img/assets/cloud/deploys_DARK.png',
22
+
}}
23
+
/>
24
+
25
+
Each card displays the following information:
26
+
- Commit SHA <Annotation>💡 The commit SHA (or hash) is the unique ID of your commit, which refers to a specific change that was made at a specific time.</Annotation>, with a direct link to your git provider, and commit message
27
+
- Deployment status:
28
+
-*Deploying*
29
+
-*Done*
30
+
-*Cancelled*
31
+
-*Build failed*
32
+
-*Deploy failed*
33
+
- Last deployment time (when the deployment was triggered and the duration)
34
+
- Production branch
35
+
36
+
## Accessing deployment details & logs
37
+
38
+
From the *Deploys* tab, you can click on the **See logs** button of any chosen deployment card to be redirected to the *Log details*. It contains the deployment's details logs.
39
+
40
+
<ThemedImage
41
+
alt="Deployment details"
42
+
sources={{
43
+
light: '/img/assets/cloud/deploy-logs.png',
44
+
dark: '/img/assets/cloud/deploy-logs_DARK.png',
45
+
}}
46
+
/>
47
+
48
+
In the *Deploy details* section of the *Log details* page is displayed the following information:
49
+
-*Status*, which can be *Building*, *Deploying*, *Done*, *Cancelled*, *Build failed*, or *Deploy failed*
50
+
-*Maintenance*: when the deployment occured
51
+
-*Deployed in*: the amount of time the deployment took
52
+
-*Commit*: the commit SHA <Annotation>💡 The commit SHA (or hash) is the unique ID of your commit, which refers to a specific change that was made at a specific time.</Annotation>, with a direct link to your git provider, and commit message used for this deployment
53
+
-*Branch*: the branch used for this deployment
54
+
55
+
In the *Logs* section of the *Log details* page you can click on the arrow buttons  to show or hide the build and deploy logs of the deployment.
56
+
57
+
:::tip
58
+
Click the **Copy to clipboard** button to copy the log contents.
0 commit comments