docs: wording and structural changes to cloud (#12820)
* docs: wording and structural changes to cloud * Fix vale error * Fix faq title * Fix heading levels * Small change to previews
This commit is contained in:
Shahed Nasser
@@ -19,9 +19,9 @@ The latest deployment of an environment is the live version of that environment,
|
||||
|
||||
### How are Deployments Created?
|
||||
|
||||
For long-lived environments, Cloud creates a new deployment every time you push a new commit to the environment's branch. For example, if your Production environment is connected to the `main` branch, Cloud will create a new Production deployment every time you push a new commit to the `main` branch.
|
||||
For long-lived environments, Medusa creates a new deployment every time you push a new commit to the environment's branch. For example, if your Production environment is connected to the `main` branch, Medusa will create a new Production deployment every time you push a new commit to the `main` branch.
|
||||
|
||||
For short-lived preview environments, Cloud creates a new environment and deployment when you open a pull request. Cloud will redeploy the preview environment every time you push a new commit to the pull request branch.
|
||||
For short-lived preview environments, Medusa creates a new environment and deployment when you open a pull request. Medusa will redeploy the preview environment every time you push a new commit to the pull request branch.
|
||||
|
||||
---
|
||||
|
||||
@@ -110,11 +110,11 @@ You can only access a deployment once its status is "Live". You can access it th
|
||||
|
||||
<Note>
|
||||
|
||||
For preview environments, refer to the [Environments](../environments/page.mdx#access-deployed-preview-environment) guide to find the URL of the preview environment.
|
||||
For preview environments, refer to the [Preview Environments](../environments/preview/page.mdx#access-deployed-preview-environment) guide to find the URL of the preview environment.
|
||||
|
||||
</Note>
|
||||
|
||||
An environment's URL is in the format `<subdomain>.medusajs.app`, where `<subdomain>` is the subdomain you set either when [creating its project](../projects/page.mdx#create-a-project) or when [creating the environment](../environments/page.mdx#create-a-long-lived-environment).
|
||||
An environment's URL is in the format `<subdomain>.medusajs.app`, where `<subdomain>` is the subdomain you set either when [creating its project](../projects/page.mdx#create-a-project) or when [creating the environment](../environments/long-lived/page.mdx#create-a-long-lived-environment).
|
||||
|
||||
You can also find the URL of a deployment's environment through the Cloud dashboard:
|
||||
|
||||
@@ -123,7 +123,7 @@ You can also find the URL of a deployment's environment through the Cloud dashbo
|
||||
|
||||
<Note title="Why are there two URLs?">
|
||||
|
||||
Aside from the subdomain you set when [creating the environment](../environments/page.mdx#create-a-long-lived-environment), Cloud also provides a unique, randomly generated URL for each environment. Both of these URLs point to the same deployment.
|
||||
Aside from the subdomain you set when [creating the environment](../environments/long-lived/page.mdx#create-a-long-lived-environment), Medusa also provides a unique, randomly generated URL for each environment. Both of these URLs point to the same deployment.
|
||||
|
||||
</Note>
|
||||
|
||||
@@ -137,7 +137,7 @@ Aside from the subdomain you set when [creating the environment](../environments
|
||||
|
||||
To access the Medusa Admin of a live deployment, click on [the environment's URL](#find-environments-url).
|
||||
|
||||
You can then log in using the email and password set either [during project creation](../projects/page.mdx#create-a-project) or [in the environment's variables](../environments/page.mdx#create-medusa-admin-user-in-environment).
|
||||
You can then log in using the email and password set either [during project creation](../projects/page.mdx#create-a-project) or [in the environment's variables](../environments/long-lived/page.mdx#create-medusa-admin-user-in-environment).
|
||||
|
||||
### Send Requests to the Deployment
|
||||
|
||||
@@ -149,13 +149,13 @@ For example, to check the health of the live deployment, you can send a `GET` re
|
||||
curl https://my-project.medusajs.app/health
|
||||
```
|
||||
|
||||
Where `my-project` is the subdomain you set either when [creating the project](../projects/page.mdx#create-a-project) or when [creating the environment](../environments/page.mdx#create-a-long-lived-environment).
|
||||
Where `my-project` is the subdomain you set either when [creating the project](../projects/page.mdx#create-a-project) or when [creating the environment](../environments/long-lived/page.mdx#create-a-long-lived-environment).
|
||||
|
||||
### Access Deployment's Server through SSH
|
||||
|
||||
Cloud doesn't support SSH access to the server instance of a deployment. However, you can still access the server's [runtime and build logs](../logs/page.mdx) to debug issues in your application.
|
||||
Medusa doesn't support SSH access to the server instance of a deployment. However, you can still access the server's [runtime and build logs](../logs/page.mdx) to debug issues in your application.
|
||||
|
||||
If this isn't sufficient for your use case, you can [contact support](../support/page.mdx) to discuss alternatives.
|
||||
If this isn't sufficient for your use case, you can contact support to discuss alternatives.
|
||||
|
||||
---
|
||||
|
||||
@@ -246,7 +246,7 @@ So, the lifecycle of a successful deployment is Building → Awaiting deployment
|
||||
|
||||
<Note>
|
||||
|
||||
If a deployment is stuck at a status like "Building" or "Deploying" for a long time, [contact support](../support/page.mdx) for assistance.
|
||||
If a deployment is stuck at a status like "Building" or "Deploying" for a long time, contact support for assistance.
|
||||
|
||||
</Note>
|
||||
|
||||
@@ -260,13 +260,13 @@ If a deployment is stuck at a status like "Building" or "Deploying" for a long t
|
||||
|
||||
If a deployment's status is "Build failed", you can check the [build logs](../logs/page.mdx) to understand why it failed. The build logs will show you the errors that occurred during the build process, which can help you fix the issue in your code.
|
||||
|
||||
You can also [contact support](../support/page.mdx) for help with the issue, if necessary.
|
||||
You can also contact support for help with the issue, if necessary.
|
||||
|
||||
### Troubleshooting Deployment Failures
|
||||
|
||||
If a deployment's status is "Deploy failed", you can check the [runtime logs](../logs/page.mdx) to understand why it failed. The runtime logs will show you the errors that occurred during the deployment process, which can help you fix the issue in your code.
|
||||
|
||||
You can also [contact support](../support/page.mdx) for help with the issue, if necessary.
|
||||
You can also contact support for help with the issue, if necessary.
|
||||
|
||||
---
|
||||
|
||||
@@ -278,7 +278,7 @@ By redeploying a previous deployment, you revert or rollback the live version of
|
||||
|
||||
<Note title="Important">
|
||||
|
||||
Redeploying a deployment will not revert database changes made in the latest deployment. If you need to revert database changes, [contact support](../support/page.mdx) for assistance based on your use case.
|
||||
Redeploying a deployment will not revert database changes made in the latest deployment. If you need to revert database changes, contact support for assistance based on your use case.
|
||||
|
||||
</Note>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user