Skip to content

Commit

Permalink
Merge branch 'main' of github.com:strapi/documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pwizla committed Aug 10, 2023
2 parents 3a603b8 + e2e42f7 commit 3b3f015
Show file tree
Hide file tree
Showing 21 changed files with 167 additions and 16 deletions.
58 changes: 50 additions & 8 deletions docusaurus/docs/cloud/account/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,69 @@ description: View and manage your projects on Strapi Cloud.
canonicalUrl: https://docs.strapi.io/cloud/account/settings.html
---

# Account Settings
# Account profile

The **Account Settings** page enables you to manage your account details and preferences. There are three sections available:
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:
The *General* tab enables you to edit the following details for your account profile:

* **Name**: The name associated with your account.
- Details: to see the name associated with your account, which is based on the one defined in your GitHub account.
- 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/account-deletion.png',
dark: '/img/assets/cloud/account-deletion_DARK.png',
}}
/>

<!--
### Modifying profile details
1. In the *Details* section of the *General* tab, modify the information of your choice:
| Setting name | Instructions |
| --------------- | ------------------------------------------------------------------------ |
| Name | Write your full name in the textbox. |
| Email | Write your complete email address in the textbox. |
2. Click on the **Save** button.
-->

### 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 edit the following details for your account:
The *Preferences* tab enables you to choose the appearance of your Strapi Cloud dashboard: either the Light or Dark theme.

* **Appearance**: Choose between the **Light** and **Dark** themes.
<ThemedImage
alt="Preferences tab of Profile page"
sources={{
light: '/img/assets/cloud/account-preferences.png',
dark: '/img/assets/cloud/account-preferences_DARK.png',
}}
/>

## Billing

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

![Account billing settings](/img/assets/cloud/account-billing.png)
<ThemedImage
alt="Billing tab of Profile page"
sources={{
light: '/img/assets/cloud/account-billing2.png',
dark: '/img/assets/cloud/account-billing2_DARK.png',
}}
/>

### Managing subscriptions

Expand Down
22 changes: 19 additions & 3 deletions docusaurus/docs/cloud/getting-started/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,16 @@ Before you can deploy your Strapi application on Strapi Cloud, you need to have
You will be shown a **plan selection** dialog.
This will allow you to select the most relevant plan for your project. Refer to [Pricing](https://strapi.io/pricing-cloud) for more information.

![Plan selection page](/img/assets/cloud/plan-selection.png)
<ThemedImage
alt="Plan selection page"
sources={{
light: '/img/assets/cloud/plan-selection.png',
dark: '/img/assets/cloud/plan-selection_DARK.png',
}}
/>

:::note
Strapi Cloud offers a free trial for only one project.

If you have already used a free trial for a previous project, the option will no longer appear in the plan selection.
:::

Expand All @@ -67,8 +72,19 @@ Before you can deploy your Strapi application on Strapi Cloud, you need to have
* **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`).
* **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.
* **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.
* **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.

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

![Project Setup](/img/assets/cloud/setup.png)
<ThemedImage
alt="Project Setup"
sources={{
light: '/img/assets/cloud/setup.png',
dark: '/img/assets/cloud/setup_DARK.png',
}}
/>

6. (**Optional**) Select **Show Advanced Settings** to configure the following options:
* **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.
Expand Down
76 changes: 76 additions & 0 deletions docusaurus/docs/cloud/projects/collaboration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
---
title: Collaboration
displayed_sidebar: cloudSidebar
description: Share your projects on Strapi Cloud to collaborate with others.
canonicalUrl: https://docs.strapi.io/cloud/projects/collaboration.md
sidebar_position: 1
---

# Collaboration on projects

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.

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:

- Cannot share the project themselves to someone else
- Cannot delete the project from the project settings
- Cannot access the *Billing* section of project settings

## Sharing a project

<ThemedImage
alt="Share button and avatar"
sources={{
light: '/img/assets/cloud/collaboration-projectview.png',
dark: '/img/assets/cloud/collaboration-projectview_DARK.png',
}}
/>

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

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

## Managing maintainers

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.

<ThemedImage
alt="Share button and avatar"
sources={{
light: '/img/assets/cloud/collaboration-dialog.png',
dark: '/img/assets/cloud/collaboration-dialog_DARK.png',
}}
/>

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:

- Pending: the invitation email has been sent but the maintainer hasn't acted on it yet.
- Expired: the email has been sent over 72 hours ago and the invitation expired.

For Expired statuses, it is possible to send another invitation email by clicking on the **Manage** button, then **Resend invite**.

### Revoking maintainers

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

1. Click on the **Share** button in the project dashboard.
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.

The revoked maintainer will completely stop having access to the project dashboard.

:::note
Maintainers whose access to the project has been revoked do not receive any email or notification.
:::
6 changes: 3 additions & 3 deletions docusaurus/docs/cloud/projects/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ The *Project Settings* page enables you to manage the configuration and settings

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

- 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.
- 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.
- Connected Git repository: to change the branch of the GitHub repository used for your project (see [Modifying GitHub repository branch](#modifying-github-repository-branch)).
- Selected region: to see the hosting region of the project.
- 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.
- Debug info: to see the internal project name for the project. This is useful for support purposes.
- Delete project: to permanently delete your Strapi Cloud project (see [Deleting Strapi Cloud project](#deleting-strapi-cloud-project)).

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

### Modifying GitHub repository branch

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

1. In the *Connected Git repository* section of the *General* tab, click on the **Edit** button.
2. In the *Edit Git settings* dialog, edit the available options of your choice:
Expand Down
2 changes: 2 additions & 0 deletions docusaurus/docs/dev-docs/configurations/environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,10 @@ Strapi provides the following environment variables:
| `BROWSER` | Open the admin panel in the browser after startup | `Boolean` | `true` |
| `ENV_PATH` | Path to the file that contains your environment variables | `String` | `'./.env'` |
| `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'` |
| `STRAPI_ENFORCE_SOURCEMAPS` | Forces the bundler to emit source-maps, which is helpful for debugging errors in the admin app. | `boolean` | `false` |
| `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` |


:::tip
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`).
:::
Expand Down
2 changes: 1 addition & 1 deletion docusaurus/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "strapi-docs",
"version": "4.12.1",
"version": "4.12.4",
"private": true,
"scripts": {
"docusaurus": "docusaurus",
Expand Down
17 changes: 16 additions & 1 deletion docusaurus/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -547,6 +547,14 @@ const sidebars = {
updated: true,
},
},
{
type: 'doc',
label: 'Collaboration',
id: 'cloud/projects/collaboration',
customProps: {
new: true,
},
},
{
type: 'doc',
label: 'Notifications',
Expand All @@ -559,7 +567,14 @@ const sidebars = {
collapsed: false,
label: 'Account Management',
items: [
'cloud/account/settings',
{
type: 'doc',
label: 'Account Settings',
id: 'cloud/account/settings',
customProps: {
updated: true,
},
},
]
},
{
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docusaurus/static/img/assets/cloud/plan-selection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docusaurus/static/img/assets/cloud/setup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

1 comment on commit 3b3f015

@vercel
Copy link

@vercel vercel bot commented on 3b3f015 Aug 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

documentation – ./

documentation-git-main-strapijs.vercel.app
docs-vercel-v4.strapi.io
documentation-strapijs.vercel.app

Please sign in to comment.