Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reviewed & complete version of Strapi Cloud documentation #1961

Merged
merged 30 commits into from
Jan 17, 2024
Merged
Show file tree
Hide file tree
Changes from 29 commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
45bd6a5
Rework TOC titles
meganelacheny Dec 1, 2023
1ba36c5
Separate account/sessing into 2 pages
meganelacheny Dec 1, 2023
8ac516c
Start working the Projects section
meganelacheny Dec 1, 2023
8297e30
Rework and complete Usage and Billing page
meganelacheny Dec 7, 2023
6eadc19
Rework Projects overview page
meganelacheny Dec 7, 2023
27102e9
Fix links in Usage and Billing
meganelacheny Dec 7, 2023
350bd9c
Separate deployment and deploy history in 2 pages and rework content …
meganelacheny Dec 7, 2023
1158273
Move deployment pages to a new Deployments section in the TOC
meganelacheny Dec 21, 2023
338a717
Review Overview and Settings pages
meganelacheny Dec 21, 2023
302473b
Review or write content for deploys docs and runtime logs
meganelacheny Dec 22, 2023
188fe95
Delete custom plan from Billing & Usage page
meganelacheny Dec 22, 2023
cfdf0cd
Mention GitLab where it was forgotten
meganelacheny Dec 22, 2023
263405b
Improve Notifications page
meganelacheny Dec 28, 2023
2a44fcb
Fix/improve all projects management pages
meganelacheny Dec 28, 2023
f052049
Fix/improve all deployments pages
meganelacheny Dec 28, 2023
792ba8e
Fix/improve Account settings page
meganelacheny Dec 28, 2023
87ab07d
Update all screenshots
meganelacheny Jan 5, 2024
410cad0
Merge branch 'main' into cloud/complete-docs
pwizla Jan 9, 2024
56e3791
Fix broken links
pwizla Jan 9, 2024
ea37630
Fix header link
pwizla Jan 11, 2024
80027b9
Remove useless link in Project settings
meganelacheny Jan 12, 2024
bfe5715
Update one more screenshot + Delete useless comments
meganelacheny Jan 12, 2024
103d09e
Add icons
meganelacheny Jan 12, 2024
54cf4eb
Merge commit
meganelacheny Jan 16, 2024
7d8ac3f
Delete More.svg in static
meganelacheny Jan 16, 2024
28431cc
Delete more.svg again
meganelacheny Jan 16, 2024
f9babaf
Add More.svg
meganelacheny Jan 16, 2024
0794a6e
Fix icon name in releases
meganelacheny Jan 16, 2024
2e1709c
Add Node version feature in Project settings + Update screenshot
meganelacheny Jan 16, 2024
7f2e424
Add forgotten word in deploy logs
meganelacheny Jan 17, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,61 +1,13 @@
---
title: Account Settings
title: Account billing details
displayed_sidebar: cloudSidebar
description: View and manage your projects on Strapi Cloud.
canonicalUrl: https://docs.strapi.io/cloud/account/settings.html
description: Manage billing details for Strapi Cloud account.
canonicalUrl: https://docs.strapi.io/cloud/account/account-billing.html
---

# Account profile
# Account billing details

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*.

## General

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

- Details: to see the name associated with your account.
- Connected accounts: to manage Google and GitHub accounts connected with your Strapi Cloud account.
- Delete account: to permanently delete your Strapi Cloud account (see [Deleting Strapi Cloud account](#deleting-strapi-cloud-account)).

<!-- TODO: replace with screenshot with connected accounts -->

<ThemedImage
alt="General tab of Profile page"
sources={{
light: '/img/assets/cloud/settings-general.png',
dark: '/img/assets/cloud/settings-general_DARK.png',
}}
/>

### Managing 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.

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.

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.

### Deleting Strapi Cloud account

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.

1. In the *Delete account* section of the *General* tab, click on the **Delete account** button.
2. In the dialog, type `DELETE` in the textbox.
3. Confirm the deletion of your account by clicking on the **Delete** button.

## Preferences

The *Preferences* tab enables you to choose the appearance of your Strapi Cloud dashboard: either the Light or Dark theme.

<ThemedImage
alt="Preferences tab of Profile page"
sources={{
light: '/img/assets/cloud/account-preferences.png',
dark: '/img/assets/cloud/account-preferences_DARK.png',
}}
/>

## Billing
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.

The *Billing* tab displays your billing information and enables you to update your payment method.

Expand All @@ -67,7 +19,7 @@ The *Billing* tab displays your billing information and enables you to update yo
}}
/>

### Managing subscriptions
## Managing subscriptions

Using the **Manage subscriptions** button, you can view and manage your subscriptions, account and billing information, and payment method.

Expand All @@ -91,7 +43,7 @@ Using the **Manage subscriptions** button, you can view and manage your subscrip
}}
/>

### Edit subscription
## Edit subscription

From the subscription management modal, you can view and modify any current subscription.

Expand All @@ -109,7 +61,7 @@ From the subscription management modal, you can view and modify any current subs
4. If you want to change plan (e.g. from Pro plan to Team plan), click on **Change** and select a new plan.
5. Confirm your modifications by clicking on the **Update Subscription** button at the bottom of the modal.

### Cancel subscription
## Cancel subscription

<ThemedImage
alt="Subscription cancellation modal"
Expand Down
56 changes: 56 additions & 0 deletions docusaurus/docs/cloud/account/account-settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
title: Profile settings
displayed_sidebar: cloudSidebar
description: Manage Strapi Cloud account settings.
canonicalUrl: https://docs.strapi.io/cloud/account/account-settings.html
---

# Profile settings

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*](#general), [*Preferences*](#preferences) and *Billing* (the latter is documented in the [Account billing details](/cloud/account/account-billing) section of this documentation).

## General

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

- Details: to see the name associated with your account.
- Connected accounts: to manage Google, GitHub and GitLab accounts connected with your Strapi Cloud account (see [Managing connected accounts](#managing-connected-accounts)).
- Delete account: to permanently delete your Strapi Cloud account (see [Deleting Strapi Cloud account](#deleting-strapi-cloud-account)).

<ThemedImage
alt="General tab of Profile page"
sources={{
light: '/img/assets/cloud/settings-general.png',
dark: '/img/assets/cloud/settings-general_DARK.png',
}}
/>

### Managing connected accounts

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.

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.

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.

### Deleting Strapi Cloud account

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.

1. In the *Delete account* section of the *General* tab, click on the **Delete account** button.
2. In the dialog, type `DELETE` in the textbox.
3. Confirm the deletion of your account by clicking on the **Delete** button.

## Preferences

The *Preferences* tab enables you to choose the appearance of your Strapi Cloud dashboard: either the Light or Dark theme.

<ThemedImage
alt="Preferences tab of Profile page"
sources={{
light: '/img/assets/cloud/account-preferences.png',
dark: '/img/assets/cloud/account-preferences_DARK.png',
}}
/>
2 changes: 1 addition & 1 deletion docusaurus/docs/cloud/getting-started/caching.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_label: 'Caching for App Performance'
sidebar_label: 'Caching for app performance'
displayed_sidebar: cloudSidebar
sidebar_position: 4
---
Expand Down
2 changes: 1 addition & 1 deletion docusaurus/docs/cloud/getting-started/deployment.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Project Creation
title: Project creation
displayed_sidebar: cloudSidebar
description: Learn how to deploy your Strapi application on Strapi Cloud.
canonicalUrl: https://docs.strapi.io/cloud/getting-started/deployment.html
Expand Down
41 changes: 20 additions & 21 deletions docusaurus/docs/cloud/getting-started/usage-billing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,48 +6,47 @@ sidebar_position: 3

# Usage & Billing

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**.
This page contains general information related to the usage and billing of your Strapi Cloud account and projects.

The usage-based pricing for Strapi Cloud is based on the following criteria and limits:
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:

| Feature | Free Trial | Pro | Team |
| --- | --- | --- | --- |
| **Seats** | 10 | 10 | 20 |
| **Database Entries** | 100,000 | 100,000 | 1,000,000 |
| **Database Entries** | 100,000 | 100,000 | 1,000,000 |
| **Assets Storage** | 5GB | 150GB | 500GB |
| **Assets Bandwidth** | 100GB | 500GB | 1,000GB |
| **Assets Bandwidth** | 100GB | 500GB per month | 1,000GB per month |
| **API Requests** | 10,000 | 1,000,000 | 2,000,000 |
| **Audit Logs** | 7 days retention | N/A | 7 days retention |
| **Releases** | 3 pending releases | N/A | 3 pending releases |

Where:

- **Seats** are the maximum number of users that can access the Strapi Admin Panel.
- **Database Entries** are the number of entries in your database.
- **Assets Storage** is the amount of storage used by your assets.
- **Assets Bandwidth** is the amount of bandwidth used by your assets.
- **API Requests** are the number of requests made to your APIs. This includes requests made to the GraphQL and REST APIs.
- **Releases** are the maximum number of pending [releases](/user-docs/releases/introduction) that can be created.
:::strapi Additional information on Strapi Cloud features
- Seats are the maximum number of users that can access the Strapi admin panel.
- Database entries are the number of entries in your database.
- Assets storage is the amount of storage used by your assets.
- Assets bandwidth is the amount of bandwidth used by your assets.
- API requests are the number of requests made to your APIs. This includes requests made to the GraphQL and REST APIs.
- Releases are the maximum number of pending [releases](/user-docs/releases/introduction) that can be created.
:::

## Seats management

Seats represent the maximum number of users that can access the Strapi Admin Panel. Each plan comes with a default number of seats.

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).
Seats represent the maximum number of users that can access the Strapi admin panel. Each plan comes with a default number of seats.

### Maximum seats
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)).

Each plan has a maximum number of seats that can be added. The maximum number of seats for each plan is as follows:
There is however a maximum number of seats that can be added per plan:

| Plan | Maximum Seats |
| --- | --- |
| **Free Trial** | 10 |
| **Pro** | 30 |
| **Team** | 50 |


## Billing

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.
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.

### Overages

Expand All @@ -58,7 +57,7 @@ For example, if you exceed the 500GB limit in asset bandwidth of the Pro plan, y
Overages are charged according to the following rates:

| Feature | Rate |
| :--- | ---: |
| --- | --- |
| **API Requests** | $1.50 / 25k requests |
| **Asset Bandwidth** | $25.00 / 100GB |
| **Asset Storage** | $2.00/GB per month |
Expand All @@ -67,7 +66,7 @@ Overages are charged according to the following rates:

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).

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.
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.

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.

Expand All @@ -77,7 +76,7 @@ If you do not resolve the issue within 10 days, your suspended project will be d

#### Project suspension after subscription cancellation

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)).
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)).

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".
2. Go back to the homepage of the billing modal, listing subscriptions and billing options.
Expand Down
12 changes: 6 additions & 6 deletions docusaurus/docs/cloud/projects/collaboration.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_position: 1

# Collaboration on projects

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.
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.

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:

Expand All @@ -28,17 +28,17 @@ Users invited to collaborate on a project, called maintainers, do not have the s

To invite a new maintainer to collaborate on a project:

1. Go to the *Overview* tab of your project dashboard.
2. Click on the **Share** button in the top right hand corner.
1. From the *Projects* page, click on the project of your choice to be redirected to its dashboard.
2. Click on the **Share** button located in the dashboard's header.
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.
4. Click on the dropdown: the email address should be displayed in a purple box right below the textbox.
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.
6. Click on the **Send** button.

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.
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.

:::tip
Avatars use GitHub or 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.
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.
:::

## Managing maintainers
Expand All @@ -64,7 +64,7 @@ For Expired statuses, it is possible to send another invitation email by clickin

To revoke a maintainer's access to the project dashboard:

1. Click on the **Share** button in the project dashboard.
1. Click on the **Share** button in the project dashboard's header.
2. In the list of *People with access*, find the maintainer whose access to revoke and click on the **Manage** button.
3. Click on the **Revoke** button.
4. In the confirmation dialog, click again on the **Revoke** button.
Expand Down
59 changes: 59 additions & 0 deletions docusaurus/docs/cloud/projects/deploys-history.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: Deploy history & logs
displayed_sidebar: cloudSidebar
description: View projects' deploy history and logs.
canonicalUrl: https://docs.strapi.io/cloud/deploys-history.html
sidebar_position: 1
---

# Deploy history and logs

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.

## Viewing deploy history

In the *Deploys* tab is displayed a chronological list of cards with the details of all historical deployments for your project.

<ThemedImage
alt="Project deploys"
sources={{
light: '/img/assets/cloud/deploys.png',
dark: '/img/assets/cloud/deploys_DARK.png',
}}
/>

Each card displays the following information:
- 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
- Deployment status:
- *Deploying*
- *Done*
- *Cancelled*
- *Build failed*
- *Deploy failed*
- Last deployment time (when the deployment was triggered and the duration)
- Production branch

## Accessing deployment details & logs

From the *Deploys* tab, you can click on the ![See logs button](/img/assets/icons/Eye.svg) **See logs** button of any chosen deployment card to be redirected to the *Log details*. It contains the deployment's details logs.

<ThemedImage
alt="Deployment details"
sources={{
light: '/img/assets/cloud/deploy-logs.png',
dark: '/img/assets/cloud/deploy-logs_DARK.png',
}}
/>

In the *Deploy details* section of the *Log details* page is displayed the following information:
- *Status*, which can be *Building*, *Deploying*, *Done*, *Cancelled*, *Build failed*, or *Deploy failed*
- *Maintenance*: when the deployment occured
- *Deployed in*: the amount of time the deployment took
- *Commit*: the commit <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
- *Branch*: the branch used for this deployment

In the *Logs* section of the *Log details* page you can click on the arrow buttons ![Down arrow](/img/assets/icons/ONHOLDCarretDown.svg) ![Up arrow](/img/assets/icons/ONHOLDCarretUp.svg) to show or hide the build and deploy logs of the deployment.

:::tip
Click the ![Copy button](/img/assets/icons/duplicate.svg) **Copy to clipboard** button to copy the log contents.
:::
Loading