tabshift/payloadcms
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

docs: misc tweaks to cloud docs

Browse Source
This commit is contained in:
Jessica Boezwinkle
2023-07-05 16:21:22 +01:00
parent dfdd334d16
commit 1db1de1116
4 changed files with 28 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/cloud/configuration.mdx
View File

@@ -25,14 +25,14 @@ Note: All Payload Cloud teams that deploy a project require a card on file. This
If you are deploying a new project from a template, the following settings will all be automatically configured for you. If you are using your own repository, you will need to make sure your build settings are accurate for your project to deploy correctly.
| Field | Description |
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Root Directory** | The folder where your `package.json` file lives. |
| **Install Command** | The command used to install your modules, for example: `yarn install` or `npm install` |
| **Build Command** | The command used to build your application, for example: `yarn build` or `npm run build` |
| **Serve Command** | The command used to serve your application, for example: `yarn serve` or `npm run serve` |
| **Branch to Deploy** | Select the branch of your repository that you want to deploy from. This is the branch that will be used to build your project when you commit new changes. |
| **Default Domain** | Set a default domain for your project. This must be unique and you aren’t able to change it. You can always add a custom domain later in your project settings. |
| Field | Description |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Root Directory** | The folder where your `package.json` file lives. |
| **Install Command** | The command used to install your modules, for example: `yarn install` or `npm install` |
| **Build Command** | The command used to build your application, for example: `yarn build` or `npm run build` |
| **Serve Command** | The command used to serve your application, for example: `yarn serve` or `npm run serve` |
| **Branch to Deploy** | Select the branch of your repository that you want to deploy from. This is the branch that will be used to build your project when you commit new changes. |
| **Default Domain** | Set a default domain for your project. This must be unique and you will not able to change it. You can always add a custom domain later in your project settings. |
### Environment Variables

12
docs/cloud/creating-a-project.mdx
View File

@@ -8,7 +8,7 @@ keywords: cloud, hosted, database, storage, email, deployment, serverless, node,
Payload Cloud is a deployment solution specifically designed for Node + MongoDB applications, offering seamless deployment of your entire stack in one place. You can get started in minutes with a one-click template, or bring your own codebase with you. Payload Cloud offers different plans tailored to meet your specific needs, including a MongoDB Atlas database, S3 file storage, and email delivery powered by Resend. To see the full breakdown of features and plans, see our [Cloud Pricing page](https://payloadcms.com/cloud-pricing).
To get started with Payload Cloud, you will first need to create an account. From the login screen, select **Register for Free**. One you’ve created an account, you’ll need to verify it by visiting the link sent to your email. After that, you can log into your account and get started.
To get started with Payload Cloud, you will first need to create an account. From the login screen, select **Register for Free**. Once you’ve created an account, you’ll need to verify it by visiting the link sent to your email. After that, you can log into your account and get started.
<Banner type="success">
To create your first project, you can either [start from a
@@ -18,7 +18,7 @@ To get started with Payload Cloud, you will first need to create an account. Fro
## Starting from a Template
Payload Cloud templates provide a one-click, simple solution to quickly deploy a new application. Templates come preconfigured, so there is no additional set up needed to run your application on Payload Cloud.
Payload Cloud templates provide a one-click, simple solution to quickly deploy a new application. Templates come pre-configured, so there is no additional set up needed to run your application on Payload Cloud.
![Screen for creating a new project from a template](https://payloadcms.com/images/docs/cloud/create-from-template.jpg)
_Creating a new project from a template._
@@ -27,19 +27,19 @@ After creating an account, select your desired template from the Projects page.
Next, select your `GitHub Scope`. If you belong to multiple organizations they will show up here. If do not see the organization you are looking for, you may need to adjust your GitHub app permissions.
After selecting your scope, choose a unique `repository name` for and select whether or not you want your repository to be public or private on GitHub.
After selecting your scope, create a unique `repository name` and select whether you want your repository to be public or private on GitHub.
<Banner type="warning">
<strong>Note:</strong> Public repositories can be accessed by anyone online,
while private repositories grant access to you and anyone you explicitly
while private repositories only grant access to you and anyone you explicitly
authorize.
</Banner>
Once you are ready, click **Create Project**. This will clone a repository of the template you selected to your GitHub account, and take you to the configuration page to set up your project for deployment.
Once you are ready, click **Create Project**. This will clone the selected template to a new respository in your GitHub account, and take you to the configuration page to set up your project for deployment.
## Importing from an Existing Codebase
Payload Cloud works for any Node + MongoDB app. From the the New Project page, select **import an existing Git codebase**. Choose the organization and select the repository you want to import. From here, you will be taken to the configuration page to set up your project for deployment.
Payload Cloud works for any Node + MongoDB app. From the New Project page, select **import an existing Git codebase**. Choose the organization and select the repository you want to import. From here, you will be taken to the configuration page to set up your project for deployment.
<Banner type="warning">
<strong>Note:</strong> In order to make use of the features of Payload Cloud

26
docs/cloud/projects.mdx
View File

@@ -9,7 +9,7 @@ keywords: cloud, payload cloud, projects, project, overview, database, file stor
### Overview
<Banner>
The overview tab shows you your most recent deployment, and its build and
The overview tab shows your most recent deployment, along with build and
deploy logs. From here, you can see your live URL, deployment details like
timestamps and commit hash, as well as the status of your deployment. You can
also trigger a redeployment manually, which will rebuild your project using
@@ -21,7 +21,7 @@ _A screenshot of the Overview page for a Cloud project._
### Database
Your Payload Cloud project comes with a MongoDB serverless Atlas DB instance or Dedicated Atlas cluster, depending on your plan. To interact with your cloud database, you use a MongoDB connection string. This can be found under the **Database** tab of your project.
Your Payload Cloud project comes with a MongoDB serverless Atlas DB instance or Dedicated Atlas cluster, depending on your plan. To interact with your cloud database, you will be provided with a MongoDB connection string. This can be found under the **Database** tab of your project.
`mongodb+srv://your_connection_string`
@@ -37,7 +37,7 @@ You can update settings from your Project’s Settings tab. Changes to your buil
### Environment Variables
From the Environment Variables page of the Settings tab, you can add new variables or adjust and delete current variables for your project. Like build settings, these changes will trigger a redeployment of your project.
From the Environment Variables page of the Settings tab, you can add, update and delete variables for use in your project. Like build settings, these changes will trigger a redeployment of your project.
<Banner>
Note: For security reasons, any variables you wish to provide to the Admin
@@ -58,34 +58,34 @@ Once you click save, a DNS record will be generated for your domain name to poin
You will also need to configure your Payload project to use your specified domain. in your `payload.config.ts` file, specify your serverURL with your domain:
```tsx
```ts
export default buildConfig({
serverURL: 'https://example.com',
serverURL: "https://example.com",
// the rest of your config,
});
```
### Email
Powered by Resend, Payload Cloud comes with integrated email support out of the box. No configuration is needed, and you can use `payload.sendEmail()` to send email right from your Payload app. To learn more about sending email with Payload, visit the [Email Configuration](https://payloadcms.com/docs/email/overview) page of the docs.
Powered by Resend, Payload Cloud comes with integrated email support out of the box. No configuration is needed, and you can use `payload.sendEmail()` to send email right from your Payload app. To learn more about sending email with Payload, checkout the [Email Configuration](https://payloadcms.com/docs/email/overview) overview.
If you are on the Pro or Enterprise plan, you can add your own custom Email domain name to send emails. From the Email page of your project’s Settings page, add the domain you wish to use for email delivery. This will generate a set of DNS records. Add these records to your DNS provider and click verify to check that your records are resolving properly. Once verified, your emails will now be sent from your custom domain name.
If you are on the Pro or Enterprise plan, you can add your own custom Email domain name. From the Email page of your project’s Settings page, add the domain you wish to use for email delivery. This will generate a set of DNS records. Add these records to your DNS provider and click verify to check that your records are resolving properly. Once verified, your emails will now be sent from your custom domain name.
### Developing Locally
To make changes to your project, you will need to clone the repository defined in your project settings to your local machine. In order to run your project locally, you will need configure your local environment first. Refer to your repository’s `README.md` file to see the steps needed for your specific template.
From there, you are ready to make updates to your project. When you want to add these changes to your live Cloud project, commit your changes to the branch you specified in your Project settings, and your application will automatically trigger a redeploy and build from your latest commit.
From there, you are ready to make updates to your project. When you are ready to make your changes live, commit your changes to the branch you specified in your Project settings, and your application will automatically trigger a redeploy and build from your latest commit.
### Cloud Plugin
Projects generated from a template will come preconfigured with the official Cloud Plugin, but if you are using your own repository you will need to add this into your project. To do so, add the plugin to your Payload config:
Projects generated from a template will come pre-configured with the official Cloud Plugin, but if you are using your own repository you will need to add this into your project. To do so, add the plugin to your Payload config:
`yarn add @payloadcms/plugin-cloud`
```jsx
import { payloadCloud } from '@payloadcms/plugin-cloud';
import { buildConfig } from 'payload/config';
```js
import { payloadCloud } from "@payloadcms/plugin-cloud";
import { buildConfig } from "payload/config";
export default buildConfig({
plugins: [payloadCloud()],
@@ -102,7 +102,7 @@ export default buildConfig({
If you wish to opt-out of any Payload cloud features, the plugin also accepts options to do so.
```jsx
```js
payloadCloud({
storage: false, // Disable file storage
email: false, // Disable email delivery

2
docs/cloud/teams.mdx
View File

@@ -16,7 +16,7 @@ _A screenshot of the Team Settings page._
### Members
Each team has member that can interact with your projects. You can invite multiple people to your team and each individual can belong to more than one team. You can delegate wether they have `owner` permissions or just User permissions. Owners are able to make admin-only changes, such as deleting projects, and editing billing information.
Each team has members that can interact with your projects. You can invite multiple people to your team and each individual can belong to more than one team. You can delegate whether they have `owner` or `user` permissions. Owners are able to make admin-only changes, such as deleting projects, and editing billing information.
### Adding Members