diff --git a/.vale.ini b/.vale.ini index abf36461d3..01fb72f70e 100644 --- a/.vale.ini +++ b/.vale.ini @@ -2,7 +2,7 @@ StylesPath = contributing/styles Vocab = Platform -MinAlertLevel = suggestion # suggestion, warning, or error +MinAlertLevel = error # suggestion, warning, or error [*.md] BasedOnStyles = Platform,Vale diff --git a/contributing/styles/config/vocabularies/Platform/accept.txt b/contributing/styles/config/vocabularies/Platform/accept.txt index 5cdc37a42a..1e647babd4 100644 --- a/contributing/styles/config/vocabularies/Platform/accept.txt +++ b/contributing/styles/config/vocabularies/Platform/accept.txt @@ -26,6 +26,7 @@ CDNs? CMS CNAMEs? [Cc]onfig +[Cc]omposable Corepack CPUs? [Cc]ron @@ -101,6 +102,7 @@ Nagios Namecheap namespace Neve +Nixpkgs [Nn]ginx NodePing Nori diff --git a/sites/platform/src/create-apps/app-reference/_index.md b/sites/platform/src/create-apps/app-reference/_index.md index 8be7bfa012..c76a52b910 100644 --- a/sites/platform/src/create-apps/app-reference/_index.md +++ b/sites/platform/src/create-apps/app-reference/_index.md @@ -25,7 +25,7 @@ You can add as many packages to your application container as you need. {{% vendor/name %}} guarantees optimal user experience with the specific [set of packages](/create-apps/app-reference/composable-image.md#supported-nix-packages) it supports. You can use any other package available from the [Nix Packages collection](https://search.nixos.org/), including unstable ones, -but NixOs is reponsible for their support. +but NixOs is responsible for their support. {{% /note %}} diff --git a/sites/platform/src/create-apps/app-reference/composable-image.md b/sites/platform/src/create-apps/app-reference/composable-image.md index fa3000cfdd..8e32430912 100644 --- a/sites/platform/src/create-apps/app-reference/composable-image.md +++ b/sites/platform/src/create-apps/app-reference/composable-image.md @@ -17,7 +17,7 @@ The composable image is built on [Nix](https://nix.dev), which offers the follow - You can add as many packages to your application container as you need, choosing from over 80,000 packages from [the Nixpkgs collection](https://search.nixos.org/packages). -- The packages you add are built in total isolation, so you can easily install different versions of the same package. +- The packages you add are built in total isolation, so you can install different versions of the same package. - With [Nix](https://nix.dev/reference/glossary#term-Nix), there are no undeclared dependencies in your source code. What works on your local machine is guaranteed to work on any other machine. @@ -42,7 +42,7 @@ To override any part of a property, you have to provide the entire property. | Name | Type | Required | Set in instance? | Description | |--------------------|-----------------------------------------------------|----------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `name` | `string` | Yes | No | A unique name for the app. Must be lowercase alphanumeric characters. Changing the name destroys data associated with the app. | -| `stack` | An array of [Nix packages](#stack) | Yes | No | A list of packages from the {{% vendor/name %}} collection of [supported runtimes](#supported-nix-packages) and/or from [NixPkgs](https://search.nixos.org/packages). | +| `stack` | An array of [Nix packages](#stack) | Yes | No | A list of packages from the {{% vendor/name %}} collection of [supported runtimes](#supported-nix-packages) and/or from [Nixpkgs](https://search.nixos.org/packages). | | `size` | A [size](#sizes) | | Yes | How much resources to devote to the app. Defaults to `AUTO` in production environments. | | `relationships` | A dictionary of [relationships](#relationships) | | Yes | Connections to other services and apps. | | `disk` | `integer` or `null` | | Yes | The size of the disk space for the app in [MB](/glossary.md#mb). Minimum value is `128`. Defaults to `null`, meaning no disk is available. See [note on available space](#available-disk-space) | diff --git a/sites/platform/src/create-apps/app-reference/single-runtime-image.md b/sites/platform/src/create-apps/app-reference/single-runtime-image.md index 41cd686b26..5025e9f667 100644 --- a/sites/platform/src/create-apps/app-reference/single-runtime-image.md +++ b/sites/platform/src/create-apps/app-reference/single-runtime-image.md @@ -57,7 +57,7 @@ use the [`source.root` property](#source). ## Types {{% note theme="info" %}} -You can now use the Upsun composable image (BETA) to install runtimes and tools in your application container. +You can now use the {{% vendor/name %}} composable image (BETA) to install runtimes and tools in your application container. If you've reached this section from another page, you may be interested in supported `stacks` where `type` was referenced. See [supported Nix packages for the `stack` key](/create-apps/app-reference/composable-image#supported-nix-packages) for more information. {{% /note %}} @@ -133,7 +133,7 @@ For more information, see how to [define relationships between your apps](/creat New syntax (default and explicit endpoints) described below is supported by most, but not all, image types (`Relationship 'SERVICE_NAME' of application 'app' ... targets a service without a valid default endpoint configuration.`). This syntax is currently being rolled out for all images. -If you encounter this error, use the "legacy" Platform.sh configuration noted at the bottom of this section. +If you encounter this error, use the "legacy" {{% vendor/name %}} configuration noted at the bottom of this section. {{< /note >}} @@ -1079,7 +1079,7 @@ You can also set your [app's runtime timezone](/create-apps/timezone.md). ### Extensions {{% note theme="info" %}} -You can now use the Upsun composable image (BETA) to install runtimes and tools in your application container. +You can now use the {{% vendor/name %}} composable image (BETA) to install runtimes and tools in your application container. If you've reached this section from another page and are using the composable image, enabling/disabling extensions should be placed under the `stack` key instead of what is listed below. See [how to configure extensions with the composable image](/create-apps/app-reference/composable-image#top-level-properties). {{% /note %}} diff --git a/sites/platform/src/create-apps/hooks/_index.md b/sites/platform/src/create-apps/hooks/_index.md index 75c2dd0907..7e30ac1f62 100644 --- a/sites/platform/src/create-apps/hooks/_index.md +++ b/sites/platform/src/create-apps/hooks/_index.md @@ -113,7 +113,7 @@ Because these steps should be done before the site accepts request, they should All of this configuration and preparation can be handled in a bash script. -1. Copy the [preparation script from the Platform.sh template](https://github.com/platformsh-templates/nextjs-drupal/blob/master/api/platformsh-scripts/hooks.deploy.sh) +1. Copy the [preparation script from the {{% vendor/name %}} template](https://github.com/platformsh-templates/nextjs-drupal/blob/master/api/platformsh-scripts/hooks.deploy.sh) into a file called `hooks.deploy.sh` in a `api/platformsh-scripts` directory. Note that hooks are executed using the dash shell, not the bash shell used by SSH logins. 2. Copy the [Drush configuration script from the template](https://github.com/platformsh-templates/nextjs-drupal/blob/master/api/drush/platformsh_generate_drush_yml.php) diff --git a/sites/platform/src/languages/php/_index.md b/sites/platform/src/languages/php/_index.md index 2748d9e33c..43be529283 100644 --- a/sites/platform/src/languages/php/_index.md +++ b/sites/platform/src/languages/php/_index.md @@ -6,7 +6,7 @@ layout: single {{% note theme="info" %}} -You can now use the Upsun composable image (BETA) to install runtimes and tools in your application container. +You can now use the {{% vendor/name %}} composable image (BETA) to install runtimes and tools in your application container. To find out more about this feature, see the [dedicated documentation page](/create-apps/app-reference/composable-image.md).
Also, see how you can [modify your PHP runtime when using a composable image](#modify-your-php-runtime-when-using-a-composable-image). @@ -611,7 +611,7 @@ See [complete working examples for C and Rust](https://github.com/platformsh-exa {{% note theme= "warning" %}} -This section is only relevant when using the Upsun [composable image (BETA)](/create-apps/app-reference/composable-image.md). +This section is only relevant when using the {{% vendor/name %}} [composable image (BETA)](/create-apps/app-reference/composable-image.md). {{% /note %}} diff --git a/sites/upsun/src/administration/billing/monitor-billing.md b/sites/upsun/src/administration/billing/monitor-billing.md index b17db917f7..f3e41de534 100644 --- a/sites/upsun/src/administration/billing/monitor-billing.md +++ b/sites/upsun/src/administration/billing/monitor-billing.md @@ -15,7 +15,7 @@ keywords: --- To help you manage costs related to your organization, -Upsun provides estimates for the current month and the next. +{{% vendor/name %}} provides estimates for the current month and the next. You can set billing alerts to ensure you don't overspend, and track resource usage on each of your projects. diff --git a/sites/upsun/src/create-apps/app-reference/_index.md b/sites/upsun/src/create-apps/app-reference/_index.md index 8be7bfa012..c76a52b910 100644 --- a/sites/upsun/src/create-apps/app-reference/_index.md +++ b/sites/upsun/src/create-apps/app-reference/_index.md @@ -25,7 +25,7 @@ You can add as many packages to your application container as you need. {{% vendor/name %}} guarantees optimal user experience with the specific [set of packages](/create-apps/app-reference/composable-image.md#supported-nix-packages) it supports. You can use any other package available from the [Nix Packages collection](https://search.nixos.org/), including unstable ones, -but NixOs is reponsible for their support. +but NixOs is responsible for their support. {{% /note %}} diff --git a/sites/upsun/src/create-apps/app-reference/composable-image.md b/sites/upsun/src/create-apps/app-reference/composable-image.md index 7a9715e85e..21fd5de566 100644 --- a/sites/upsun/src/create-apps/app-reference/composable-image.md +++ b/sites/upsun/src/create-apps/app-reference/composable-image.md @@ -17,7 +17,7 @@ The composable image is built on [Nix](https://nix.dev), which offers the follow - You can add as many packages to your application container as you need, choosing from over 80,000 packages from [the Nixpkgs collection](https://search.nixos.org/packages). -- The packages you add are built in total isolation, so you can easily install different versions of the same package. +- The packages you add are built in total isolation, so you can install different versions of the same package. - With [Nix](https://nix.dev/reference/glossary#term-Nix), there are no undeclared dependencies in your source code. What works on your local machine is guaranteed to work on any other machine. diff --git a/sites/upsun/src/create-apps/app-reference/single-runtime-image.md b/sites/upsun/src/create-apps/app-reference/single-runtime-image.md index 12414643e1..d3df9d8737 100644 --- a/sites/upsun/src/create-apps/app-reference/single-runtime-image.md +++ b/sites/upsun/src/create-apps/app-reference/single-runtime-image.md @@ -79,7 +79,7 @@ use the [`source.root` property](#source). ## Types {{% note theme="info" %}} -You can now use the Upsun composable image (BETA) to install runtimes and tools in your application container. +You can now use the {{% vendor/name %}} composable image (BETA) to install runtimes and tools in your application container. If you've reached this section from another page, you may be interested in supported `stacks` where `type` was referenced. See [supported Nix packages for the `stack` key](/create-apps/app-reference/composable-image#supported-nix-packages) for more information. {{% /note %}} @@ -223,20 +223,11 @@ applications: If you already have a directory with that name, you get a warning that it isn't accessible after the build. See how to [troubleshoot the warning](../troubleshoot-mounts.md#overlapping-folders). -<<<<<<<< HEAD:sites/upsun/src/create-apps/app-reference/single-runtime-image.md -| Name | Type | Required | Description | -|---------------|--------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `source` | `storage`, `tmp`, or `service` | Yes | Specifies the type of the mount:

- By design, `storage` mounts can be shared between instances of the same app. You can also configure them so they are [shared between different apps](#share-a-mount-between-several-apps).

- `tmp` mounts are local ephemeral mounts, where an external directory is mounted to the `/tmp` directory of your app.
The content of a `tmp` mount **may be removed during infrastructure maintenance operations**. Therefore, `tmp` mounts allow you to **store files that you’re not afraid to lose**, such as your application cache that can be seamlessly rebuilt.
Note that the `/tmp` directory has **a maximum allocation of 8 GB**.

- `service` mounts can be useful if you want to explicitly define and use a [Network Storage](/add-services/network-storage.md) service to share data between different apps (instead of using a `storage` mount). | -| `source_path` | `string` | No | Specifies where the mount points **inside the [external directory](#mounts)**.

- If you explicitly set a `source_path`, your mount points to a specific subdirectory in the external directory.

- If the `source_path` is an empty string (`""`), your mount points to the entire external directory.

- If you don't define a `source_path`, {{% vendor/name %}} uses the {{< variable "MOUNT_PATH" >}} as default value, without leading or trailing slashes.
For example, if your mount lives in the `/web/uploads/` directory in your app container, it will point to a directory named `web/uploads` in the external directory.

**WARNING:** Changing the name of your mount affects the `source_path` when it's undefined. See [how to ensure continuity](#ensure-continuity-when-changing-the-name-of-your-mount) and maintain access to your files. | -| `service` | `string` | | The purpose of the `service` key depends on your use case.

In a multi-app context where a `storage` mount is shared between apps, `service` is required. Its value is the name of the app whose mount you want to share. See how to [share a mount between several apps](#share-a-mount-between-several-apps).

In a multi-app context where a [Network Storage service](/add-services/network-storage.md) (`service` mount) is shared between apps, `service` is required and specifies the name of that Network Storage. | -======== - | Name | Type | Required | Description | | ------------- | -------------------- | -------- | ----------- | | `source` | `storage`, `instance`, `tmp` (also called `temporary`), or `service` | Yes | Specifies the type of the mount:

- By design, `storage` mounts can be shared between instances of the same app. You can also configure them so they are [shared between different apps](#share-a-mount-between-several-apps).

-`instance` mounts are local mounts. Unique to your app, they are useful to store files that remain local to the app instance, such as application logs.

- `tmp` (or `temporary`) mounts are local ephemeral mounts, where an external directory is mounted to the `/tmp` directory of your app.
The content of a `tmp` mount **may be removed during infrastructure maintenance operations**. Therefore, `tmp` mounts allow you to **store files that you’re not afraid to lose**, such as your application cache that can be seamlessly rebuilt.
Note that the `/tmp` directory has **a maximum allocation of 8 GB**.

- `service` mounts can be useful if you want to explicitly define and use a [Network Storage](/add-services/network-storage.md) service to share data between different apps (instead of using a `storage` mount).| | `source_path` | `string` | No | Specifies where the mount points **inside the [external directory](#mounts)**.

- If you explicitly set a `source_path`, your mount points to a specific subdirectory in the external directory.

- If the `source_path` is an empty string (`""`), your mount points to the entire external directory.

- If you don't define a `source_path`, {{% vendor/name %}} uses the {{< variable "MOUNT_PATH" >}} as default value, without leading or trailing slashes.
For example, if your mount lives in the `/web/uploads/` directory in your app container, it will point to a directory named `web/uploads` in the external directory.

**WARNING:** Changing the name of your mount affects the `source_path` when it's undefined. See [how to ensure continuity](#ensure-continuity-when-changing-the-name-of-your-mount) and maintain access to your files. | | `service` | `string` | | The purpose of the `service` key depends on your use case.

In a multi-app context where a `storage` mount is shared between apps, `service` is required. Its value is the name of the app whose mount you want to share. See how to [share a mount between several apps](#share-a-mount-between-several-apps).

In a multi-app context where a [Network Storage service](/add-services/network-storage.md) (`service` mount) is shared between apps, `service` is required and specifies the name of that Network Storage. | ->>>>>>>> ga-staging:sites/upsun/src/create-apps/app-reference.md The accessibility to the web of a mounted directory depends on the [`web.locations` configuration](#web). Files can be all public, all private, or with different rules for different paths and file types. @@ -389,25 +380,6 @@ Follow these steps: Note that another way to share data between apps through a mount is by explicitly [defining a Network Storage service](/add-services/network-storage.md). -<<<<<<<< HEAD:sites/upsun/src/create-apps/app-reference/single-runtime-image.md -### Local mounts - -If you need a local mount (i.e. unique per container), -{{% vendor/name %}} allows you to mount a directory within the `/tmp` directory of your app. -However, the following limitations apply: - -- Content from `tmp` mounts is removed when your app container is moved to another host during an infrastructure - maintenance operation -- The `/tmp` directory has a [maximum allocation of 8 GB](/create-apps/troubleshoot-disks.md#no-space-left-on-device) - -Therefore, `tmp` mounts are ideal to store non-critical data, such as your application cache which can be seamlessly -rebuilt, -but aren't suitable for storing files that are necessary for your app to run smoothly. - -Note that {{% vendor/name %}} will provide new local mounts in the near future. - -======== ->>>>>>>> ga-staging:sites/upsun/src/create-apps/app-reference.md ## Web Use the `web` key to configure the web server running in front of your app. @@ -1152,7 +1124,7 @@ You can also set your [app's runtime timezone](/create-apps/timezone.md). ### Extensions {{% note theme="info" %}} -You can now use the Upsun composable image (BETA) to install runtimes and tools in your application container. +You can now use the {{% vendor/name %}} composable image (BETA) to install runtimes and tools in your application container. If you've reached this section from another page and are using the composable image, enabling/disabling extensions should be placed under the `stack` key instead of what is listed below. See [how to configure extensions with the composable image](/create-apps/app-reference/composable-image#top-level-properties). {{% /note %}} @@ -1212,11 +1184,11 @@ The following table shows the properties that can be set in `source`: ## Container profile -By default, Upsun allocates a container profile to each app and service depending on the range of resources it’s +By default, {{% vendor/name %}} allocates a container profile to each app and service depending on the range of resources it’s expected to need. Each container profile gives you access to a specific list of CPU and RAM combinations. -Using the Upsun CLI or Console, you can then pick a CPU and RAM combination for each of your apps and services. +Using the {{% vendor/name %}} CLI or Console, you can then pick a CPU and RAM combination for each of your apps and services. - [Container profile types and resources](/manage-resources/adjust-resources#advanced-container-profiles) - [Default container profiles](/manage-resources/adjust-resources#default-container-profiles) for runtime and service diff --git a/sites/upsun/src/get-started/here/_index.md b/sites/upsun/src/get-started/here/_index.md index 013ab19841..16bda08e15 100644 --- a/sites/upsun/src/get-started/here/_index.md +++ b/sites/upsun/src/get-started/here/_index.md @@ -1,20 +1,20 @@ --- sidebarTitle: Introduction -title: Getting started with Upsun +title: Getting started with {{% vendor/name %}} weight: -100 layout: single # aliases: # - /get-started/_index.md --- -Welcome to Upsun! +Welcome to {{% vendor/name %}}! -Follow this guide to set up your very first custom application on Upsun. -In the process, you will learn more about Upsun, what it does, and how you can work with it to your best advantage. +Follow this guide to set up your very first custom application on {{% vendor/name %}}. +In the process, you will learn more about {{% vendor/name %}}, what it does, and how you can work with it to your best advantage. -{{< note title="Have you seen the Upsun demo?" theme="info" >}} +{{< note title="Have you seen the demo?" theme="info" >}} -Find out how Upsun works and gain a better understanding of what it provides. To check the demo out, [create a new project](https://console.upsun.com/projects/create-project) and select **Deploy demo project**. +Find out how {{% vendor/name %}} works and gain a better understanding of what it provides. To check the demo out, [create a new project](https://console.upsun.com/projects/create-project) and select **Deploy demo project**. {{< /note >}} diff --git a/sites/upsun/src/get-started/here/configure/_index.md b/sites/upsun/src/get-started/here/configure/_index.md index 04447eb28f..b19d016366 100644 --- a/sites/upsun/src/get-started/here/configure/_index.md +++ b/sites/upsun/src/get-started/here/configure/_index.md @@ -61,10 +61,10 @@ Commit your new files: git add . && git commit -m "Add configuration for {{% vendor/name %}}." ``` -Push up to your Upsun project: +Push up to your {{% vendor/name %}} project: ```bash -upsun push +{{% vendor/cli %}} push ``` {{% vendor/name %}} now reads your configuration files, begins building your application image and allocates resources to your various containers. @@ -85,7 +85,7 @@ title=Using {{% vendor/name %}} CLI Found 749 commits E: Error parsing configuration files: -- : Configuration directory '.upsun' not found. +- : Configuration directory '.{{% vendor/cli %}}' not found. E: Error: Invalid configuration files, aborting build ``` @@ -96,7 +96,7 @@ title=Using Console ![Create project options](/images/console/first-fail.png "0.4") {{< /codetabs >}} -This error is triggered because you have not yet added Upsun configuration to your project to setup deployments. +This error is triggered because you have not yet added {{% vendor/name %}} configuration to your project to setup deployments. ## Errors diff --git a/sites/upsun/src/get-started/here/configure/nodejs.md b/sites/upsun/src/get-started/here/configure/nodejs.md index ec018594fe..03a42cd206 100644 --- a/sites/upsun/src/get-started/here/configure/nodejs.md +++ b/sites/upsun/src/get-started/here/configure/nodejs.md @@ -5,7 +5,7 @@ weight: 10 --- When dealing with Javascript/Node.js stacks, the information below may help customize your configuration. -These sections provide Javascript/Node.js-specific configuration details, but you can also refer to the common Upsun documentation: +These sections provide Javascript/Node.js-specific configuration details, but you can also refer to the common {{% vendor/name %}} documentation: - [Configuring applications](/create-apps) - [Setting up managed services](/add-services) @@ -13,7 +13,7 @@ These sections provide Javascript/Node.js-specific configuration details, but yo ## Build flavors -By default, Upsun makes assumptions about how you want to build your application. +By default, {{% vendor/name %}} makes assumptions about how you want to build your application. Namely, that you are managing your dependencies with npm, and that the very first thing you'd like to run is a particular and common production flavor of `npm install`. This is called a build `flavor`, but its assumption may prove inappropriate for your application and cause your builds to fail (such as if you'd like to use yarn or bun instead of npm). @@ -21,7 +21,7 @@ Therefore, you can [disable this feature](/languages/nodejs#dependencies). ## Available package managers -Certain package managers come pre-installed on all Upsun `nodejs` container types: +Certain package managers come pre-installed on all {{% vendor/name %}} `nodejs` container types: * *npm*; example: ``npm install platformsh-config`` * *npx*; example: ``npx create-strapi-app `` @@ -148,7 +148,7 @@ routes: ## Frameworks -The Upsun documentation includes a wide array of community resources to help with framework-specific configuration: +The {{% vendor/name %}} documentation includes a wide array of community resources to help with framework-specific configuration: - [Express](/get-started/stacks/express) - [Next.js](/get-started/stacks/nextjs) @@ -156,11 +156,11 @@ The Upsun documentation includes a wide array of community resources to help wit ## Get support -While there are virtually no restrictions to you deploying any kind of application on Upsun, configuration may still be unclear at this point. +While there are virtually no restrictions to you deploying any kind of application on {{% vendor/name %}}, configuration may still be unclear at this point. -Not to worry! The Upsun community is here to help. +Not to worry! The {{% vendor/name %}} community is here to help. Come and say hello, share your work, ask for help, and peek in on what others are working on. -Welcome to the Upsun community! +Welcome to the {{% vendor/name %}} community! {{% community-buttons %}} diff --git a/sites/upsun/src/get-started/here/configure/php.md b/sites/upsun/src/get-started/here/configure/php.md index 5f0bc07f23..82cab4a74f 100644 --- a/sites/upsun/src/get-started/here/configure/php.md +++ b/sites/upsun/src/get-started/here/configure/php.md @@ -5,7 +5,7 @@ weight: 15 --- When dealing with PHP stacks, the information below may help customize your configuration. -These sections provide PHP-specific configuration details, but you can also refer to the common Upsun documentation: +These sections provide PHP-specific configuration details, but you can also refer to the common {{% vendor/name %}} documentation: - [Configuring applications](/create-apps) - [Setting up managed services](/add-services) @@ -13,7 +13,7 @@ These sections provide PHP-specific configuration details, but you can also refe ## Build flavors -By default, Upsun makes assumptions about how you want to build your application. +By default, {{% vendor/name %}} makes assumptions about how you want to build your application. Namely, that you are managing your dependencies with Composer, and that the very first thing you'd like to run is a particular and common production flavor of `composer install`. This is called a build `flavor`, but its assumption may prove inappropriate for your application and cause your builds to fail. @@ -25,7 +25,7 @@ Packagist is the primary Composer repository for public PHP packages. But you ca ## PHP settings -Upsun provides additional configuration possibilities to control: +{{% vendor/name %}} provides additional configuration possibilities to control: - [PHP-FPM runtime configuration](/create-apps/app-reference#runtime) - [PHP settings](/languages/php#php-settings) @@ -39,25 +39,25 @@ See which [PHP extensions](/languages/php/extensions) are available for your ver ## Web servers -While PHP-FPM is the default behavior, Upsun provides some support for different web servers by modifying the `web.commands.start` property: +While PHP-FPM is the default behavior, {{% vendor/name %}} provides some support for different web servers by modifying the `web.commands.start` property: - [Alternate start commands](/languages/php#alternate-start-commands) - [Swoole](/languages/php/swoole) ## Frameworks -The Upsun documentation includes a wide array of community resources to help with framework-specific configuration: +The {{% vendor/name %}} documentation includes a wide array of community resources to help with framework-specific configuration: - [Laravel](/get-started/stacks/laravel) - [Symfony](/get-started/stacks/symfony) ## Get support -While there are virtually no restrictions to you deploying any kind of application on Upsun, configuration may still be unclear at this point. +While there are virtually no restrictions to you deploying any kind of application on {{% vendor/name %}}, configuration may still be unclear at this point. -Not to worry! The Upsun community is here to help. +Not to worry! The {{% vendor/name %}} community is here to help. Come and say hello, share your work, ask for help, and peek in on what others are working on. -Welcome to the Upsun community! +Welcome to the {{% vendor/name %}} community! {{% community-buttons %}} diff --git a/sites/upsun/src/get-started/here/configure/python.md b/sites/upsun/src/get-started/here/configure/python.md index 9aa2f731a7..b56b7c8cfa 100644 --- a/sites/upsun/src/get-started/here/configure/python.md +++ b/sites/upsun/src/get-started/here/configure/python.md @@ -5,7 +5,7 @@ weight: 20 --- When dealing with Python stacks, the information below may help customize your configuration. -These sections provide Python-specific configuration details, but you can also refer to the common Upsun documentation: +These sections provide Python-specific configuration details, but you can also refer to the common {{% vendor/name %}} documentation: - [Configuring applications](/create-apps) - [Setting up managed services](/add-services) @@ -20,25 +20,25 @@ Alternatively, you can [use a different package manager](/languages/python/depen ## Configuring web servers -Upsun doesn't enforce an assumption of what Python web server package you are using to serve your applications. -You can use any server on Upsun by modifying the `web.commands.start` property of your application configuration. +{{% vendor/name %}} doesn't enforce an assumption of what Python web server package you are using to serve your applications. +You can use any server on {{% vendor/name %}} by modifying the `web.commands.start` property of your application configuration. For more information, see how to [configure web servers](/languages/python/server). ## Frameworks -The Upsun documentation includes a wide array of community resources to help with framework-specific configuration: +The {{% vendor/name %}} documentation includes a wide array of community resources to help with framework-specific configuration: - [Django](/get-started/stacks/django) - [Flask](/get-started/stacks/flask) ## Get support -While there are virtually no restrictions to you deploying any kind of application on Upsun, configuration may still be unclear at this point. +While there are virtually no restrictions to you deploying any kind of application on {{% vendor/name %}}, configuration may still be unclear at this point. -Not to worry! The Upsun community is here to help. +Not to worry! The {{% vendor/name %}} community is here to help. Come and say hello, share your work, ask for help, and peek in on what others are working on. -Welcome to the Upsun community! +Welcome to the {{% vendor/name %}} community! {{% community-buttons %}} diff --git a/sites/upsun/src/get-started/here/create-project.md b/sites/upsun/src/get-started/here/create-project.md index 7efc0b6429..1f22cf663e 100644 --- a/sites/upsun/src/get-started/here/create-project.md +++ b/sites/upsun/src/get-started/here/create-project.md @@ -10,7 +10,7 @@ To create a new project on {{% vendor/name %}}, you can take one of two paths:
Using the Console (recommended) -Open the [Upsun management console](https://console.upsun.com/-/create-project) to create your project. +Open the [{{% vendor/name %}} management console](https://console.upsun.com/-/create-project) to create your project. {{% note %}} If you haven't done so already, you are prompted to create your first organization where your project will reside. @@ -19,13 +19,13 @@ If you haven't done so already, you are prompted to create your first organizati ![Create project options](/images/console/create-project.png "0.4") From the Console, what you do next entirely depends on where the "source of truth" of your codebase is located. -In this guide, you will push your local repository to Upsun. +In this guide, you will push your local repository to {{% vendor/name %}}. That is, the only copy of your codebase you'd like to deploy is on your local computer. Click **Start from scratch** from the **Deploy with Git** option. {{< note theme="info" title="Git integrations">}} -This guide does not specifically address integrating an Upsun project with a third party repository such as one on GitHub, even though the **Connect repository** option is available at this stage. +This guide does not specifically address integrating an {{% vendor/name %}} project with a third party repository such as one on GitHub, even though the **Connect repository** option is available at this stage. For now, continue to work locally. Third party integrations will be addressed at the end of this guide. @@ -40,7 +40,7 @@ Add details about your project, such as: As suggested in the Console, connect the local copy of your repository to your project: ```bash -upsun project:set-remote {{< variable "PROJECT_ID" >}} +{{% vendor/cli %}} project:set-remote {{< variable "PROJECT_ID" >}} ``` Your local source code is automatically linked to your newly created {{% vendor/name %}} project through the creation of a `.{{% vendor/cli %}}/local/project.yaml` file. This file contains the corresponding `` and sets a Git remote to `{{% vendor/cli %}}`. @@ -64,17 +64,17 @@ Then, you are asked if you want to set the local remote to your new project. Ent Your local source code is automatically linked to your newly created {{% vendor/name %}} project through the creation of a `.{{% vendor/cli %}}/local/project.yaml` file. This file contains the corresponding `` and sets a Git remote to `{{% vendor/cli %}}`. -In this guide, you will push your local repository to Upsun. +In this guide, you will push your local repository to {{% vendor/name %}}. That is, the only copy of your codebase you'd like to deploy is on your local computer. {{< note theme="info" title="Git integrations">}} -This guide does not specifically address integrating an Upsun project with a third party repository such as one on GitHub, even though you will notice the **Connect repository** option available at this stage. +This guide does not specifically address integrating an {{% vendor/name %}} project with a third party repository such as one on GitHub, even though you will notice the **Connect repository** option available at this stage. For now, continue to work locally. Third party integrations will be addressed at the end of this guide. {{< /note >}} -So long as you chose `y` (yes) to the question `Set the new project as the remote for this repository?` during the `project:create` command, your local project is already integrated to the Upsun project. +So long as you chose `y` (yes) to the question `Set the new project as the remote for this repository?` during the `project:create` command, your local project is already integrated to the {{% vendor/name %}} project.
diff --git a/sites/upsun/src/get-started/here/make-changes.md b/sites/upsun/src/get-started/here/make-changes.md index e6a771b0ef..fd7047f5fa 100644 --- a/sites/upsun/src/get-started/here/make-changes.md +++ b/sites/upsun/src/get-started/here/make-changes.md @@ -5,7 +5,7 @@ weight: 50 description: How to work on a daily basis with an {{% vendor/name %}} project? --- -Upsun allows you to make changes to your project and test them on a preview environment before introducing them to Production. +{{% vendor/name %}} allows you to make changes to your project and test them on a preview environment before introducing them to Production. In your project, the default branch (e.g. `main`, `master`, whichever chosen during project creation) always represents the production environment. Other branches are for developing new features, fixing bugs, or updating the infrastructure. diff --git a/sites/upsun/src/get-started/here/setup.md b/sites/upsun/src/get-started/here/setup.md index 2110267405..bce0af288c 100644 --- a/sites/upsun/src/get-started/here/setup.md +++ b/sites/upsun/src/get-started/here/setup.md @@ -41,13 +41,13 @@ While the guide has been written to accommodate the following stacks, it is not {{% guides/requirements %}} {{% note theme="info" title="Trials" %}} -When you create your first organization on Upsun, you are also activating your trial for that organization. +When you create your first organization on {{% vendor/name %}}, you are also activating your trial for that organization. Get [more information on trials](/glossary#trial). {{% /note %}} ## Initialize your Git repository -A Git repository is required for Upsun projects. +A Git repository is required for {{% vendor/name %}} projects. If you haven't already done so, initialize a Git repository for your codebase, and commit your files: ```bash {location="Terminal"} @@ -61,7 +61,7 @@ Your Git configuration may result in different default branches (like `master`), {{< note theme="info" title="Don't commit dependencies" >}} -Whether you're migrating your own project, or testing Upsun with a starter project, **never commit your app's dependencies**. +Whether you're migrating your own project, or testing {{% vendor/name %}} with a starter project, **never commit your app's dependencies**. Make sure you ignore directories containing dependencies by updating your `.gitignore` file. ```bash diff --git a/sites/upsun/src/get-started/here/support.md b/sites/upsun/src/get-started/here/support.md index b71418f84a..b3ca25eb39 100644 --- a/sites/upsun/src/get-started/here/support.md +++ b/sites/upsun/src/get-started/here/support.md @@ -3,9 +3,9 @@ title: Get support weight: 80 --- -There are virtually no restrictions to you deploying any kind of application on Upsun, and we're excited to hear about your experiments! +There are virtually no restrictions to you deploying any kind of application on {{% vendor/name %}}, and we're excited to hear about your experiments! Follow the links below to share your work, ask the community for help, and peek in on what others are working on. -Welcome to the Upsun community! +Welcome to the {{% vendor/name %}} community! {{% community-buttons %}} \ No newline at end of file diff --git a/sites/upsun/src/get-started/here/third-party.md b/sites/upsun/src/get-started/here/third-party.md index c03e51e4df..e075b0d7df 100644 --- a/sites/upsun/src/get-started/here/third-party.md +++ b/sites/upsun/src/get-started/here/third-party.md @@ -3,19 +3,19 @@ title: Third party integrations weight: 75 --- -In this guide, you've configured and deployed a local copy of your codebase to Upsun. -You can continue to work, but the primary remote your team would share would be Upsun itself. +In this guide, you've configured and deployed a local copy of your codebase to {{% vendor/name %}}. +You can continue to work, but the primary remote your team would share would be {{% vendor/name %}} itself. It's more likely that your codebase is on a third party Git service like GitHub, GitLab, or Bitbucket. -Now that you've learned the basics of Upsun configuration and deployment, you can create new projects within the management console, by choosing the **Connect repository** option to set up a GitHub application. +Now that you've learned the basics of {{% vendor/name %}} configuration and deployment, you can create new projects within the management console, by choosing the **Connect repository** option to set up a GitHub application. -At this stage, if you want to make another remote (i.e. `origin`) the primary remote, and Upsun a deployment mirror, you can override your current configuration by setting up an integration: +At this stage, if you want to make another remote (i.e. `origin`) the primary remote, and {{% vendor/name %}} a deployment mirror, you can override your current configuration by setting up an integration: - [BitBucket](/integrations/source/bitbucket.md) - [GitHub](/integrations/source/github.md) - [GitLab](/integrations/source/gitlab.md) -Once the integration is added, all commits on the service are mirrored, built, and deployed on Upsun. +Once the integration is added, all commits on the service are mirrored, built, and deployed on {{% vendor/name %}}. {{< guide-buttons previous="Back" next="Getting support" nextLink="/get-started/here/support" type="*" >}} diff --git a/sites/upsun/src/get-started/stacks/_index.md b/sites/upsun/src/get-started/stacks/_index.md index 18a7dbeb22..8d048317e0 100644 --- a/sites/upsun/src/get-started/stacks/_index.md +++ b/sites/upsun/src/get-started/stacks/_index.md @@ -6,12 +6,12 @@ layout: single # - /get-started/_index.md --- -Upsun aims to provide sane defaults out-of-the-box, while exposing a high degree of flexibility when you are configuring your projects, environments, and applications. -Because of this, you can deploy most frameworks on Upsun. +{{% vendor/name %}} aims to provide sane defaults out-of-the-box, while exposing a high degree of flexibility when you are configuring your projects, environments, and applications. +Because of this, you can deploy most frameworks on {{% vendor/name %}}. Below are some common examples sorted by programming language. {{< note theme="info" >}} -Before you start, check out the [Upsun demo app](https://console.upsun.com/projects/create-project) and the main [Getting started guide](/get-started/here). +Before you start, check out the [{{% vendor/name %}} demo app](https://console.upsun.com/projects/create-project) and the main [Getting started guide](/get-started/here). They provide all the core concepts and common commands you need to know before using the following materials. {{< /note >}} diff --git a/sites/upsun/src/get-started/stacks/express/_index.md b/sites/upsun/src/get-started/stacks/express/_index.md index d0139a78ee..7bcbd3d656 100644 --- a/sites/upsun/src/get-started/stacks/express/_index.md +++ b/sites/upsun/src/get-started/stacks/express/_index.md @@ -1,5 +1,5 @@ --- -title: Deploying Express on Upsun +title: Deploying Express on {{% vendor/name %}} sectionBefore: Javascript/Node.js sidebarTitle: Express weight: -100 @@ -291,7 +291,7 @@ To make changes to your project, follow these steps: block content h1= title - p Welcome to #{title} - + p Welcome to #{title} on Upsun + + p Welcome to #{title} on {{% vendor/name %}} `` 3. Commit your changes: @@ -341,4 +341,4 @@ To make changes to your project, follow these steps: ### Blogs -- [A quick-start guide on hosting Express on Upsun](https://upsun.com/blog/setting-up-express-on-upsun/) +- [A quick-start guide on hosting Express on {{% vendor/name %}}](https://upsun.com/blog/setting-up-express-on-upsun/) diff --git a/sites/upsun/src/get-started/stacks/express/add-database.md b/sites/upsun/src/get-started/stacks/express/add-database.md index 0291816904..a1408bf05c 100644 --- a/sites/upsun/src/get-started/stacks/express/add-database.md +++ b/sites/upsun/src/get-started/stacks/express/add-database.md @@ -83,10 +83,10 @@ npm install mysql2 ``` Wherever your application code attemps to connect to the database service, -Upsun will automatically generate environment variables containing connection credentials as a function of the relationship name. +{{% vendor/name %}} will automatically generate environment variables containing connection credentials as a function of the relationship name. In this example, the MariaDB service access is granted to the application container via the relationship `database`. -Upsun will therefore generate the variable `DATABASE_HOST` (among many others), using this name. +{{% vendor/name %}} will therefore generate the variable `DATABASE_HOST` (among many others), using this name. Here's an example of how this credential variable naming convention is used to connect to a MariaDB service: diff --git a/sites/upsun/src/get-started/stacks/flask.md b/sites/upsun/src/get-started/stacks/flask.md index 68136eae58..84b62f10ef 100644 --- a/sites/upsun/src/get-started/stacks/flask.md +++ b/sites/upsun/src/get-started/stacks/flask.md @@ -281,7 +281,7 @@ To do so, follow these steps. 3. Set up a way for your local instance of Flask to communicate with your database service: ```bash {location="Terminal"} - upsun tunnel:open -y + {{% vendor/cli %}} tunnel:open -y ``` This opens an SSH tunnel to all the services for the app. @@ -296,7 +296,7 @@ To do so, follow these steps. Set the following environment variable: ```bash {location=".environment"} - export PLATFORM_RELATIONSHIPS="$(upsun tunnel:info --encode)" + export PLATFORM_RELATIONSHIPS="$({{% vendor/cli %}} tunnel:info --encode)" ``` Since you now have this environmental variable set locally, you can reuse your `.environment` file for {{% vendor/name %}} to recreate diff --git a/sites/upsun/src/get-started/stacks/laravel/_index.md b/sites/upsun/src/get-started/stacks/laravel/_index.md index 7e55a06b10..5083b17985 100644 --- a/sites/upsun/src/get-started/stacks/laravel/_index.md +++ b/sites/upsun/src/get-started/stacks/laravel/_index.md @@ -1,5 +1,5 @@ --- -title: Deploying Laravel on Upsun +title: Deploying Laravel on {{% vendor/name %}} sidebarTitle: Laravel sectionBefore: PHP layout: single diff --git a/sites/upsun/src/get-started/stacks/nextjs.md b/sites/upsun/src/get-started/stacks/nextjs.md index 877144b1c4..b0f2c03ba6 100644 --- a/sites/upsun/src/get-started/stacks/nextjs.md +++ b/sites/upsun/src/get-started/stacks/nextjs.md @@ -1,5 +1,5 @@ --- -title: Deploying Next.js on Upsun +title: Deploying Next.js on {{% vendor/name %}} sidebarTitle: Next.js weight: -97 layout: single @@ -293,7 +293,7 @@ To make changes to your project, follow these steps: block content h1= title - p Welcome to #{title} - + p Welcome to #{title} on Upsun + + p Welcome to #{title} on {{% vendor/name %}} `` 3. Commit your changes: @@ -342,4 +342,4 @@ To make changes to your project, follow these steps: ### Blogs -- [A quick-start guide on hosting Next.js on Upsun](https://upsun.com/blog/setting-up-next-js-on-upsun/) +- [A quick-start guide on hosting Next.js on {{% vendor/name %}}](https://upsun.com/blog/setting-up-next-js-on-upsun/) diff --git a/sites/upsun/src/get-started/stacks/strapi/_index.md b/sites/upsun/src/get-started/stacks/strapi/_index.md index 348632d596..c6e7b976ec 100644 --- a/sites/upsun/src/get-started/stacks/strapi/_index.md +++ b/sites/upsun/src/get-started/stacks/strapi/_index.md @@ -1,5 +1,5 @@ --- -title: Deploying Strapi on Upsun +title: Deploying Strapi on {{% vendor/name %}} sidebarTitle: Strapi weight: -90 layout: single @@ -45,7 +45,7 @@ To create your Strapi app, follow these steps. {{< note >}} You can view the running app locally by running `yarn develop`. The local server will be visible at `localhost:1337`. - You can create your first administrator user locally, but you will have to recreate that user once you've deployed to Upsun. + You can create your first administrator user locally, but you will have to recreate that user once you've deployed to {{% vendor/name %}}. {{< /note >}} ## 2. Create a new project diff --git a/sites/upsun/src/get-started/stacks/strapi/add-database.md b/sites/upsun/src/get-started/stacks/strapi/add-database.md index 7cf3ee95a7..07730176ff 100644 --- a/sites/upsun/src/get-started/stacks/strapi/add-database.md +++ b/sites/upsun/src/get-started/stacks/strapi/add-database.md @@ -7,14 +7,14 @@ description: | {{% description %}} -This guide will show you how to provision and connect to two different databases on Upsun: +This guide will show you how to provision and connect to two different databases on {{% vendor/name %}}: - PostgreSQL - Oracle MySQL ## 1. Branch -Like all updates to your Upsun projects, first create a new dedicated environment to test this change. +Like all updates to your {{% vendor/name %}} projects, first create a new dedicated environment to test this change. ```bash git checkout -b upgrade-db @@ -141,7 +141,7 @@ export DATABASE_PASSWORD="$DB_PASSWORD" export DATABASE_SCHEME="$DB_SCHEME" # Set secrets needed by Strapi, if they are not set -# Prefer setting these as project secret variables with upsun variable:create env:SECRET_NAME --sensitive=true +# Prefer setting these as project secret variables with {{% vendor/cli %}} variable:create env:SECRET_NAME --sensitive=true if [[ -z "$ADMIN_JWT_SECRET" ]]; then export ADMIN_JWT_SECRET="$PLATFORM_PROJECT_ENTROPY" fi @@ -156,7 +156,7 @@ if [[ -z "$APP_KEYS" ]]; then fi ``` -Upsun will actually generate service credentials automatically for you in the runtime container, so we don't need the first half of this file anymore. +{{% vendor/name %}} will actually generate service credentials automatically for you in the runtime container, so we don't need the first half of this file anymore. Remove the first block (pertaining to `DATABASE` credentials). Then, add a single additional variable that will set the `DATABASE_CLIENT` variable at the appropriate time: @@ -167,7 +167,7 @@ title=PostgreSQL +++ ```bash {location=".environment"} # Set secrets needed by Strapi, if they are not set -# Prefer setting these as project secret variables with upsun variable:create env:SECRET_NAME --sensitive=true +# Prefer setting these as project secret variables with {{% vendor/cli %}} variable:create env:SECRET_NAME --sensitive=true if [[ -z "$ADMIN_JWT_SECRET" ]]; then export ADMIN_JWT_SECRET="$PLATFORM_PROJECT_ENTROPY" fi @@ -193,7 +193,7 @@ title=Oracle MySQL +++ ```bash {location=".environment"} # Set secrets needed by Strapi, if they are not set -# Prefer setting these as project secret variables with upsun variable:create env:SECRET_NAME --sensitive=true +# Prefer setting these as project secret variables with {{% vendor/cli %}} variable:create env:SECRET_NAME --sensitive=true if [[ -z "$ADMIN_JWT_SECRET" ]]; then export ADMIN_JWT_SECRET="$PLATFORM_PROJECT_ENTROPY" fi @@ -216,7 +216,7 @@ fi ## 6. Push to the environment -Commit and push the changes to the Upsun environment: +Commit and push the changes to the {{% vendor/name %}} environment: ```bash git commit -am "Add a new service" @@ -224,6 +224,6 @@ git push origin upgrade-db ``` {{< note theme="info">}} -If you are using Upsun as your primary remote, you can use the `upsun branch` and `upsun push` commands directly. +If you are using {{% vendor/name %}} as your primary remote, you can use the `{{% vendor/cli %}} branch` and `{{% vendor/cli %}} push` commands directly. If instead you had already set up an integration to GitHub, GitLab or Bitbucket, make sure to open a pull/merge request to judge the revision. {{< /note >}} diff --git a/sites/upsun/src/get-started/stacks/symfony/_index.md b/sites/upsun/src/get-started/stacks/symfony/_index.md index 90537626b1..39cf7f3ebd 100644 --- a/sites/upsun/src/get-started/stacks/symfony/_index.md +++ b/sites/upsun/src/get-started/stacks/symfony/_index.md @@ -1,10 +1,10 @@ --- -title: Deploying Symfony on Upsun +title: Deploying Symfony on {{% vendor/name %}} sidebarTitle: Symfony layout: single weight: -60 description: | - Welcome to the Upsun documentation specific to the [Symfony](https://www.symfony.com/) framework on Upsun. + Welcome to the {{% vendor/name %}} documentation specific to the [Symfony](https://www.symfony.com/) framework on {{% vendor/name %}}. It includes common reference materials useful for deploying Symfony, but also external community and blog resources that cover more advanced topics relevant for the framework. --- diff --git a/sites/upsun/src/get-started/stacks/wordpress.md b/sites/upsun/src/get-started/stacks/wordpress.md index 010a4850db..4ff213b740 100644 --- a/sites/upsun/src/get-started/stacks/wordpress.md +++ b/sites/upsun/src/get-started/stacks/wordpress.md @@ -1,5 +1,5 @@ --- -title: Deploy WordPress on Upsun +title: Deploy WordPress on {{% vendor/name %}} sidebarTitle: WordPress weight: -55 description: | @@ -15,11 +15,11 @@ They provide all the core concepts and common commands you need to know before u {{< /note >}} For WordPress to successfully deploy and operate, after completing the [Getting started guide](/get-started/here/_index.md), -you still need to add some required files and make a few changes to your Upsun configuration. +you still need to add some required files and make a few changes to your {{% vendor/name %}} configuration. ## Before you begin -There are many ways you can set up a WordPress site or Upsun project. +There are many ways you can set up a WordPress site or {{% vendor/name %}} project. The instructions on this page were designed based on the following assumptions: - You are building a composer-based WordPress site using John P Bloch's [WordPress Composer Fork](https://github.com/johnpbloch/wordpress). @@ -252,7 +252,7 @@ You can now commit all the changes made to `.upsun/config.yaml` and push to Upsu ```bash {location="Terminal"} git add . - git commit -m "Add changes to complete my Upsun configuration" + git commit -m "Add changes to complete my {{% vendor/name %}} configuration" git push ``` diff --git a/sites/upsun/src/languages/php/_index.md b/sites/upsun/src/languages/php/_index.md index 1d7d7cf51a..aa056d139a 100644 --- a/sites/upsun/src/languages/php/_index.md +++ b/sites/upsun/src/languages/php/_index.md @@ -6,7 +6,7 @@ layout: single {{% note theme="info" %}} -You can now use the Upsun composable image (BETA) to install runtimes and tools in your application container. +You can now use the {{% vendor/name %}} composable image (BETA) to install runtimes and tools in your application container. To find out more about this feature, see the [dedicated documentation page](/create-apps/app-reference/composable-image.md).
Also, see how you can [modify your PHP runtime when using a composable image](#modify-your-php-runtime-when-using-a-composable-image). @@ -635,7 +635,7 @@ See dedicated guides for deploying and working with them: {{% note theme= "warning" %}} -This section is only relevant when using the Upsun [composable image (BETA)](/create-apps/app-reference/composable-image.md). +This section is only relevant when using the {{% vendor/name %}} [composable image (BETA)](/create-apps/app-reference/composable-image.md). {{% /note %}} diff --git a/sites/upsun/src/languages/php/extensions.md b/sites/upsun/src/languages/php/extensions.md index 5f50d300c9..3bc49980b1 100644 --- a/sites/upsun/src/languages/php/extensions.md +++ b/sites/upsun/src/languages/php/extensions.md @@ -6,7 +6,7 @@ description: See what PHP extensions are available with each PHP version on {{% {{% note theme="info" %}} -You can now use the [Upsun composable image (BETA)](/create-apps/app-reference/composable-image.md) to install runtimes and tools in your application container. +You can now use the [{{% vendor/name %}} composable image (BETA)](/create-apps/app-reference/composable-image.md) to install runtimes and tools in your application container. When using the composable image, see how you can: - [Manage PHP extensions](/create-apps/app-reference/composable-image.md#php-extensions-and-python-packages) - [Modify your PHP runtime](#modify-your-php-runtime-when-using-a-composable-image) diff --git a/sites/upsun/src/learn/overview/yaml/yaml-structure.md b/sites/upsun/src/learn/overview/yaml/yaml-structure.md index 89e11b7f13..df799abc9f 100644 --- a/sites/upsun/src/learn/overview/yaml/yaml-structure.md +++ b/sites/upsun/src/learn/overview/yaml/yaml-structure.md @@ -9,8 +9,8 @@ In addition to the [basic functions you should be familiar with](./what-is-yaml. ## YAML file location -When you run the [`upsun project:init` command](/get-started/here/configure/_index.md), a default ``config.yaml`` file is generated in the `.upsun` folder. It contains the minimum default configuration based on your detected local stack. -This YAML file is located in your ``.upsun`` directory, at the root of your project source code, and is a good starting point before customization. +When you run the [`{{% vendor/cli %}} project:init` command](/get-started/here/configure/_index.md), a default ``config.yaml`` file is generated in the `.{{% vendor/cli %}}` folder. It contains the minimum default configuration based on your detected local stack. +This YAML file is located in your ``.{{% vendor/cli %}}`` directory, at the root of your project source code, and is a good starting point before customization. ```bash . @@ -34,7 +34,7 @@ This looks like: mariadb: type: mariadb:10.6 # All available versions are: 10.6, 10.5, 10.4, 10.3 -{{< code-link destination="/define-routes.md" text="routes" title="The routes of the project. Each route describes how an incoming URL is going to be processed by Upsun (Staging). Click for more information." >}}: +{{< code-link destination="/define-routes.md" text="routes" title="The routes of the project. Each route describes how an incoming URL is going to be processed by {{% vendor/name %}} (Staging). Click for more information." >}}: "https://{default}/": type: upstream upstream: "app:http" diff --git a/sites/upsun/src/manage-resources/resource-init.md b/sites/upsun/src/manage-resources/resource-init.md index 70e0a712f6..3b2da8da19 100644 --- a/sites/upsun/src/manage-resources/resource-init.md +++ b/sites/upsun/src/manage-resources/resource-init.md @@ -56,7 +56,7 @@ Note that you can [monitor these costs](/administration/billing/monitor-billing. {{% note theme="info" title="More information on..."%}}
- Upsun minimum resources + {{% vendor/name %}} minimum resources The following table shows the resources {{% vendor/name %}} allocates to your containers when you opt for the `minimum` [resource initialization strategy](#specify-a-resource-initialization-strategy). @@ -130,13 +130,13 @@ you can use a [Git push option](/environments/_index.md#push-options) to specify To do so, run the following command: ```bash {location="Terminal"} -upsun push --resources-init={{< variable "INITIALIZATION_STRATEGY" >}} +{{% vendor/cli %}} push --resources-init={{< variable "INITIALIZATION_STRATEGY" >}} ``` For example, to use the `minimum` strategy for your deployment, run the following command: ```bash {location="Terminal"} -upsun push --resources-init=minimum +{{% vendor/cli %}} push --resources-init=minimum ``` {{< note >}} @@ -144,7 +144,7 @@ upsun push --resources-init=minimum Alternatively, you can use the official Git syntax for [push options](/environments/_index.md#push-options): ```bash {location="Terminal"} -git push upsun -o resources.init=minimum +git push {{% vendor/cli %}} -o resources.init=minimum ``` {{< /note >}} @@ -185,13 +185,13 @@ To specify a resource initialization strategy for an existing source integration run the following command: ```bash {location="Terminal"} -upsun integration:update --resources-init={{< variable "INITIALIZATION_STRATEGY" >}} +{{% vendor/cli %}} integration:update --resources-init={{< variable "INITIALIZATION_STRATEGY" >}} ``` For example, to use the `minimum` strategy for your deployment, run the the following command: ```bash {location="Terminal"} -upsun integration:update --resources-init=minimum +{{% vendor/cli %}} integration:update --resources-init=minimum ``` {{< /codetabs >}} @@ -227,13 +227,13 @@ title=Using the CLI Run the following command: ```bash {location="Terminal"} -upsun environment:branch --resources-init={{< variable "INITIALIZATION_STRATEGY" >}} +{{% vendor/cli %}} environment:branch --resources-init={{< variable "INITIALIZATION_STRATEGY" >}} ``` For example, to use the `minimum` resource initialization strategy, run the following command: ```bash {location="Terminal"} -upsun environment:branch --resources-init=minimum +{{% vendor/cli %}} environment:branch --resources-init=minimum ``` <---> @@ -280,13 +280,13 @@ title=Using the CLI Run the following command: ```bash {location="Terminal"} -upsun environment:merge --resources-init={{< variable "INITIALIZATION_STRATEGY" >}} +{{% vendor/cli %}} environment:merge --resources-init={{< variable "INITIALIZATION_STRATEGY" >}} ``` For example, to use the `manual` resource initialization strategy, run the following command: ```bash {location="Terminal"} -upsun environment:merge --resources-init=manual +{{% vendor/cli %}} environment:merge --resources-init=manual ``` <---> @@ -321,13 +321,13 @@ You can also specify a different resource initialization strategy using the CLI. To do so, run the following command: ```bash {location="Terminal"} -upsun environment:activate --resources-init={{< variable "INITIALIZATION_STRATEGY" >}} +{{% vendor/cli %}} environment:activate --resources-init={{< variable "INITIALIZATION_STRATEGY" >}} ``` For example, to use the `minimum` resource initialization strategy, run the following command: ```bash {location="Terminal"} -upsun environment:activate --resources-init=minimum +{{% vendor/cli %}} environment:activate --resources-init=minimum ``` {{% note %}} @@ -373,13 +373,13 @@ you can specify a different resource initialization strategy for all of them. Run the following command: ```bash {location="Terminal"} -upsun backup:restore --resources-init={{< variable "INITIALIZATION_STRATEGY" >}} +{{% vendor/cli %}} backup:restore --resources-init={{< variable "INITIALIZATION_STRATEGY" >}} ``` For example, to use the `minimum` resource initialization strategy, run the following command: ```bash {location="Terminal"} -upsun backup:restore --resources-init=minimum +{{% vendor/cli %}} backup:restore --resources-init=minimum ``` <---> @@ -433,25 +433,25 @@ Run the following commands depending on your needs: - Sync only resources: ```bash {location="Terminal"} - upsun sync resources + {{% vendor/cli %}} sync resources ``` - Sync only code: ```bash {location="Terminal"} - upsun sync code + {{% vendor/cli %}} sync code ``` - Sync only data: ```bash {location="Terminal"} - upsun sync data + {{% vendor/cli %}} sync data ``` - Sync everything: ```bash {location="Terminal"} - upsun sync code data resources + {{% vendor/cli %}} sync code data resources ``` You can adjust the command depending on the exact combination of elements you want to sync.