Skip to content

Commit

Permalink
Strapi Cloud: GitLab as new git provider + new signup page (#1942)
Browse files Browse the repository at this point in the history
* Update deployment.md and all screenshots

* Mention GitLab whenever only GitHub was written as only git provider

* Add more updates for GitLab as new provider

* Add link to GitLab documentation

* Add prerequisite about GitLab permission required
  • Loading branch information
meganelacheny authored Dec 6, 2023
1 parent bf2979e commit 1691664
Show file tree
Hide file tree
Showing 12 changed files with 19 additions and 18 deletions.
25 changes: 13 additions & 12 deletions docusaurus/docs/cloud/getting-started/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ Before you can deploy your Strapi application on Strapi Cloud, you need to have

* Strapi version `4.8.2` or higher
* Project database must be compatible with PostgreSQL. Strapi does not support and does not recommend using any external databases, though it's possible to configure one (see [advanced database configuration](/cloud/advanced/database)).
* Project(s) source code hosted on [GitHub](https://github.com). The connected repository can contain multiple Strapi applications. Each Strapi app must be in a separate directory.
* Project(s) source code hosted on [GitHub](https://github.com) or [GitLab](https://about.gitlab.com/). The connected repository can contain multiple Strapi applications. Each Strapi app must be in a separate directory.
* Specifically for GitLab: at least have "[Maintainer](https://docs.gitlab.com/ee/user/permissions.html)" permissions for the project to import on Strapi Cloud.
:::

## Logging in to Strapi Cloud
Expand Down Expand Up @@ -44,7 +45,7 @@ Before you can deploy your Strapi application on Strapi Cloud, you need to have
}}
/>

2. You will be redirected to the first project creation interface. This interface contains 3 steps: choosing a plan, connecting a GitHub repository, and setting up the project.
2. You will be redirected to the first project creation interface. This interface contains 3 steps: choosing a plan, connecting a git repository, and setting up the project.

<ThemedImage
alt="Strapi Cloud project creation, step 1"
Expand All @@ -60,19 +61,19 @@ Before you can deploy your Strapi application on Strapi Cloud, you need to have
Strapi Cloud offers a free trial for only one project and you will not need to share your credit card details to create your first project. Once the free trial has already been used for a previous project, the option will no longer appear in the plan selection.
:::

4. Connect a GitHub repository to your new Strapi Cloud project.
4. Connect a git repository to your new Strapi Cloud project.

:::strapi Choose your path to create your new Strapi Cloud project!
Select one of the tabs below depending on how you wish to proceed:
- by using a prebuilt template and creating a new GitHub repository to discover Strapi Cloud easily and quickly *(recommended for new users and beginners)*,
- or by using your own, already existing GitHub repository and Strapi project.
- by using a prebuilt template and creating a new repository on GitHub to discover Strapi Cloud easily and quickly *(recommended for new users and beginners — not available on another provider than GitHub)*,
- or by using your own, already existing GitHub or GitLab repository and Strapi project.
:::

<Tabs groupId="REPO-OPTIONS">

<TabItem value="TEMPLATE" label="New repo & prebuilt template ✨">

4.a. Click on the **Use template** button.
4.a. Click on the **Use template** button. If you are creating a project for the first time, you may first have to select GitHub as git provider and then you will see the option to use a template.

4.b. In the *Create repository with template* modal, choose:

Expand Down Expand Up @@ -106,18 +107,18 @@ Before you can deploy your Strapi application on Strapi Cloud, you need to have

<TabItem value="OWN-REPO" label="Own existing repo & Strapi project">

4.a. Click on the **Connect GitHub repositories** button.
4.a. (optional) If you are creating a project for the first time, you may first have to select a git provider: either GitHub or GitLab. If you already created a project with one git provider, you can afterward create another project using another provider by clicking on the **Switch git provider** button and selecting either GitHub or GitLab.

:::tip
Connect the GitHub account and/or organizations that own the repository or repositories you want to deploy. This can be different from the account that owns the Strapi Cloud account.
Connect the GitHub or GitLab account and/or organizations that own the repository or repositories you want to deploy. This can be different from the account that owns the Strapi Cloud account.
:::

4.b. If you have already given Strapi Cloud access to all repositories of your GitHub account, go directly to the next step. If not, you will be redirected to a GitHub modal where you will have to allow Strapi Cloud permission to access your repositories (more information in the [GitHub documentation](https://docs.github.com/en/apps/overview)).
4.b. If you have already given Strapi Cloud access to all repositories of your GitHub or GitLab account, go directly to the next step. If not, you will be redirected to a modal where you will have to allow Strapi Cloud permission to access some or all your repositories on GitHub/GitLab (more information in the [GitHub](https://docs.github.com/en/apps/overview) and [GitLab](https://docs.gitlab.com/ee/integration/oauth_provider.html#view-all-authorized-applications) documentations).

4.c. Back in the project creation interface, select your *Account* and a *Repository*.

<ThemedImage
alt="Selecting GitHub account and repository"
alt="Selecting git account and repository"
sources={{
light: '/img/assets/cloud/account-repo-selection.png',
dark: '/img/assets/cloud/account-repo-selection_DARK.png',
Expand All @@ -135,12 +136,12 @@ Before you can deploy your Strapi application on Strapi Cloud, you need to have
| Setting name | Instructions |
|--------------|---------------------------------------------------------------------------------------------------------|
| Display name | Write 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 | Choose from the drop-down 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. |
| Git branch | Choose from the drop-down the default branch to use for this deployment. This uses the default branch of the repository. |
| Deploy on push | Check the box to automatically deploy the latest changes from the selected branch. When disabled, you will need to manually deploy the latest changes. |
| Region | Choose the geographic location of the servers where your Strapi application is hosted. Selected region can either be New York 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)).
The Git 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)).
:::

5.b. (optional) Click on **Show advanced settings** to fill in the following options:
Expand Down
2 changes: 1 addition & 1 deletion docusaurus/docs/cloud/getting-started/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Strapi Cloud is a managed content platform built on top of Strapi, the leading o

Strapi Cloud enables you to increase your content velocity without having to compromise on customization needs and requirements. Development teams can rely on Strapi Cloud to abstract away the complexity of infrastructure management while keeping your development workflow and extending the core capabilities of Strapi. Content managers can use Strapi Cloud to autonomously manage all types of content and benefit from a complete set of content collaboration, security, and compliance features.

The typical workflow is to create your Strapi (v4.8.2 or later) application locally, extend the application with plugins or custom code, version the application's codebase through GitHub, and deploy the application in seconds with Strapi Cloud (see [deployment and prerequisites](/cloud/getting-started/deployment#prerequisites)).
The typical workflow is to create your Strapi (v4.8.2 or later) application locally, extend the application with plugins or custom code, version the application's codebase through your git provider (GitHub or GitLab), and deploy the application in seconds with Strapi Cloud (see [deployment and prerequisites](/cloud/getting-started/deployment#prerequisites)).

## Strapi Community

Expand Down
2 changes: 1 addition & 1 deletion docusaurus/docs/cloud/projects/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ The deployment details page displays the following information:
* **Status**: Whether the project is **Building**, **Deploying**, **Done**, **Cancelled**, **Build failed**, or **Deploy failed**.
* **Triggered**: When the deployment was triggered.
* **Deployed In**: The time it took to deploy the project.
* **Commit**: The commit used for this deployment. Click the commit SHA to view the commit on GitHub.
* **Commit**: The commit used for this deployment. Click the commit SHA to view the commit on GitHub/GitLab.
* **Branch**: The branch used for this deployment.
* **Logs**: The Build, Deploy, and Runtime logs of the deployment. Click the **copy logs** button to copy the log contents.

Expand Down
8 changes: 4 additions & 4 deletions docusaurus/docs/cloud/projects/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ 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 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)).
- Connected git repository: to change the branch of the GitHub or GitLab repository used for your project (see [Modifying git repository branch](#modifying-git-repository-branch)).
- 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)).
Expand All @@ -28,11 +28,11 @@ The *General* tab enables you to check and update the following options for the
}}
/>

### Modifying GitHub repository branch
### Modifying git 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 project's settings.
The GitHub or Gitlab 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.
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:

| Setting name | Instructions |
Expand Down
Binary file modified docusaurus/static/img/assets/cloud/login.png
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/login_DARK.png
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/project-creation-1.png
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/project-creation-1_DARK.png
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/project-creation-2.png
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/project-creation-2_DARK.png
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/projects-empty.png
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/projects-empty_DARK.png
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 1691664

@vercel
Copy link

@vercel vercel bot commented on 1691664 Dec 6, 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
documentation-strapijs.vercel.app
docs-vercel-v4.strapi.io

Please sign in to comment.