diff --git a/.github/workflows/check-links.yaml b/.github/workflows/check-links.yaml index 8e64814608..3985ecbfc8 100644 --- a/.github/workflows/check-links.yaml +++ b/.github/workflows/check-links.yaml @@ -21,4 +21,4 @@ jobs: - name: Check links env: URL: https://pr-2189-odiepqq-652soceglkw4u.eu-3.platformsh.site - run: ./muffet --buffer-size=8192 --rate-limit=1 --max-connections-per-host=10 --color=always --header="User-Agent:Mozilla/5.0 (Windows NT 10.0) Gecko/20100101 Firefox/91.0" --exclude=https://console.platform.sh/projects/create-project https://pr-2189-odiepqq-652soceglkw4u.eu-3.platformsh.site + run: ./muffet --buffer-size=8192 --rate-limit=1 --max-connections-per-host=10 --color=always --header="User-Agent:Mozilla/5.0 (Windows NT 10.0) Gecko/20100101 Firefox/91.0" -e=console.platform.sh/projects/create-project -e=cloud.orange-business.com -e=developers.cloudflare.com -e=discord.com -e=pptr.dev https://pr-2189-odiepqq-652soceglkw4u.eu-3.platformsh.site diff --git a/docs/layouts/shortcodes/clone-commit.md b/docs/layouts/shortcodes/clone-commit.md new file mode 100644 index 0000000000..98f7a574c9 --- /dev/null +++ b/docs/layouts/shortcodes/clone-commit.md @@ -0,0 +1,10 @@ +## Clones and commits + +You can clone your codebase by running `platform get ` +or in your project in the console by going to Code > Git and running the `git clone` command. + +When you perform this action, you are actually cloning from your remote integrated repository, +so long as you have the [appropriate access to do so](/integrations/source/troubleshoot.html). + +Your {{ .Get "name" }} repository is considered to be the source of truth for the project. +The project is only a mirror of that repository and all commits should be pushed only to {{ .Get "name" }}. diff --git a/docs/layouts/shortcodes/gen-3-services.html b/docs/layouts/shortcodes/gen-3-services.html index 623aa65019..c886643d01 100644 --- a/docs/layouts/shortcodes/gen-3-services.html +++ b/docs/layouts/shortcodes/gen-3-services.html @@ -4,11 +4,12 @@ Supported versions {{- range $image, $info := .Site.Data.registry -}} - {{- if (isset $info "versions-dedicated-gen-3") -}} + {{- if and (isset $info "versions-dedicated-gen-3") (ne $image "redis-persistent") -}} {{- $label := index $info "name" -}} {{- $versions := index ( index $info "versions-dedicated-gen-3") "supported" -}} + {{- $docs_link := index (index $info "docs") "url" -}} - {{ $label }} + {{ $label }} {{- $service_versions := "" -}} {{- range $versions -}} diff --git a/docs/layouts/shortcodes/guides/gatsby/headless-backend.html b/docs/layouts/shortcodes/guides/gatsby/headless-backend.html index 8bd4192ee4..7a81c809bd 100644 --- a/docs/layouts/shortcodes/guides/gatsby/headless-backend.html +++ b/docs/layouts/shortcodes/guides/gatsby/headless-backend.html @@ -1 +1,6 @@ -

There has only been a single modification to Platform.sh’s standard {{ .Get "name" }} template configuration in the multi-app template: the name attibribute in {{ .Get "name" }}’s .platform.app.yaml has been updated to {{ anchorize ( .Get "name" )}}. You will notice this value used when the relationship between Gatsby and {{ .Get "name" }} is defined below for Gatsby and in the routes configuration above.

+{{ $name := .Get "name" }} +{{ $template := $name }} +{{ if eq $name "Drupal" }} + {{ $template = "Drupal9"}} +{{ end }} +

There has only been a single modification to Platform.sh’s standard {{ $name }} template configuration in the multi-app template: the name attibribute in {{ $name }}’s .platform.app.yaml has been updated to {{ anchorize ( $name )}}. You will notice this value used when the relationship between Gatsby and {{ $name }} is defined below for Gatsby and in the routes configuration above.

diff --git a/docs/layouts/shortcodes/guides/gatsby/headless-gatsby.html b/docs/layouts/shortcodes/guides/gatsby/headless-gatsby.html index 6bda21ff6b..907cf226fd 100644 --- a/docs/layouts/shortcodes/guides/gatsby/headless-gatsby.html +++ b/docs/layouts/shortcodes/guides/gatsby/headless-gatsby.html @@ -12,7 +12,7 @@

  • post_deploy

    -

    Platform.sh containers reside in separate build containers at build time, before their images are moved to the final application container at deploy time. These build containers are isolated, and therefore Gatsby does not have access to {{ .Get "name" }} during the build hook, where you would normally run gatsby build. {{ .Get "name" }} will not be available until after the deploy hook, and so Gatsby’s build is postponed until the post_deploy hook below.

    +

    Platform.sh containers reside in separate build containers at build time, before their images are moved to the final application container at deploy time. These build containers are isolated, and therefore Gatsby does not have access to {{ .Get "name" }} during the build hook, where you would normally run gatsby build. {{ .Get "name" }} will not be available until after the deploy hook, and so Gatsby’s build is postponed until the post_deploy hook below.

  • mounts

    diff --git a/docs/layouts/shortcodes/guides/lando.html b/docs/layouts/shortcodes/guides/lando.html index 4ab3a01391..a3d838aaec 100644 --- a/docs/layouts/shortcodes/guides/lando.html +++ b/docs/layouts/shortcodes/guides/lando.html @@ -1,4 +1,4 @@ -

    Lando is Platform.sh’s recommended local development tool. Lando can read your Platform.sh configuration files for Wordpress and produce an approximately equivalent configuration using Docker with minimal effort. See the Lando documentation for installing and setting up Lando on your system.

    +

    Lando is Platform.sh’s recommended local development tool. Lando can read your Platform.sh configuration files for Wordpress and produce an approximately equivalent configuration using Docker with minimal effort. See the Lando documentation for installing and setting up Lando on your system.

    Templates come configured for use already with a base Landofile shown below, which can be helpful getting started with Lando without the need to have a project on Platform.sh. This file sets up good defaults for Lando and Platform.sh-configured codebases, most notably through the recipe attribute.

    {{ $file := printf "static/files/fetch/lando/%s" (.Get "repo" ) }} @@ -6,6 +6,6 @@

    This Landofile is also the place where you can configure access to tools that would normally be available within a Platform.sh app container (such as the WordPress CLI), that you would also want access to locally.

    -

    You can replicate this file, or otherwise follow the directions in the Lando documentation for Platform.sh to setup the repository locally. Once you have completed the configuration, you can then start to local environment by running:

    +

    You can replicate this file, or otherwise follow the directions in the Lando documentation for Platform.sh to setup the repository locally. Once you have completed the configuration, you can then start to local environment by running:

    $ lando start
    diff --git a/docs/layouts/shortcodes/language-specification.md b/docs/layouts/shortcodes/language-specification.md index d51bb78ecc..50a8f40946 100644 --- a/docs/layouts/shortcodes/language-specification.md +++ b/docs/layouts/shortcodes/language-specification.md @@ -1,7 +1,7 @@ {{ $type := .Get "type" }} ### Specify the language -To use {{ .Get "display_name" }}, specify `{{ $type }}` as your [app's `type`](/configuration/app/app-reference.html#type): +To use {{ .Get "display_name" }}, specify `{{ $type }}` as your [app's `type`](/configuration/app/app-reference.html#types):
    .platform.app.yaml
    diff --git a/docs/layouts/shortcodes/spring-common-props.md b/docs/layouts/shortcodes/spring-common-props.md new file mode 100644 index 0000000000..648ccee384 --- /dev/null +++ b/docs/layouts/shortcodes/spring-common-props.md @@ -0,0 +1,2 @@ +For access to more credentials options, check [Spring common application properties](https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html) +and [binding from environment variables](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables). diff --git a/docs/src/administration/users.md b/docs/src/administration/users.md index d5ecb415d5..b2eb782479 100644 --- a/docs/src/administration/users.md +++ b/docs/src/administration/users.md @@ -172,4 +172,4 @@ Once the transfer is completed, the new organization can administer all project ## Troubleshooting If you have setup an external integration to GitHub, GitLab, or Bitbucket and your users can't clone the project locally, -see how to [troubleshoot source integrations](/integrations/source/troubleshoot.md). +see how to [troubleshoot source integrations](../integrations/source/troubleshoot.md). diff --git a/docs/src/administration/web/_index.md b/docs/src/administration/web/_index.md index 379e9b1a60..36d2f1149a 100644 --- a/docs/src/administration/web/_index.md +++ b/docs/src/administration/web/_index.md @@ -126,12 +126,11 @@ The **CLI** tab displays the command to get your project set up locally with the The **Git** tab displays the command to clone the codebase via Git. If you're using Platform.sh as your primary remote repository, the command clones from the project. -If you have set up an [external integration](/integrations/source/_index.md), the command clones directly from the integrated remote repository. - -If the project uses an external integration to a repository that you have not been given access to, you will not be able to clone until your access has been updated. See [User access and integrations](/administration/users.md#user-access-and-integrations) for more information. - - +If you have set up an [external integration](../../integrations/source/_index.md), the command clones directly from the integrated remote repository. +If the project uses an external integration to a repository that you haven't been given access to, +you can't clone until your access has been updated. +See how to [troubleshoot source integrations](../../integrations/source/troubleshoot.md). ### Configuration settings diff --git a/docs/src/configuration/app/app-reference.md b/docs/src/configuration/app/app-reference.md index e63fc27af9..b55d3f936e 100644 --- a/docs/src/configuration/app/app-reference.md +++ b/docs/src/configuration/app/app-reference.md @@ -396,7 +396,7 @@ Each rule has the following properties where at least one is required and `ips` | Name | Type | Default | Description | | --------- | ------------------- | --------------- | ----------- | -| `ips` | Array of `string`s | `["0.0.0.0/0"]` | IP addresses in [CIDR notation](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). See a [CIDR format converter](https://ipaddressguide.com/cidr). | +| `ips` | Array of `string`s | `["0.0.0.0/0"]` | IP addresses in [CIDR notation](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). See a [CIDR format converter](https://www.ipaddressguide.com/cidr). | | `domains` | Array of `string`s | | [Fully qualified domain names](https://en.wikipedia.org/wiki/Fully_qualified_domain_name) to specify specific destinations by hostname. | | `ports` | Array of `integer`s | | Ports from 1 to 65535 that are allowed. If any ports are specified, all unspecified ports are blocked. If no ports are specified, all ports are allowed. Port `25`, the SMTP port for sending email, is always blocked. | diff --git a/docs/src/configuration/app/hooks/_index.md b/docs/src/configuration/app/hooks/_index.md index 93730bffd7..8afd0c20a8 100644 --- a/docs/src/configuration/app/hooks/_index.md +++ b/docs/src/configuration/app/hooks/_index.md @@ -70,7 +70,7 @@ The template uses [Drush](https://www.drush.org/latest/) to handle routine tasks For its configuration, Drush needs the URL of the site. That means the configuration can't be done in the `build` hook. During the `build` hook, the site isn't yet deployed and so there is no URL to use in the configuration. -(The [`PLATFORM_ROUTES` variable](../../../development/variables/use-variables.md#use--platformsh-provided-variables) isn't available.) +(The [`PLATFORM_ROUTES` variable](../../../development/variables/use-variables.md#use-platformsh-provided-variables) isn't available.) Add the configuration during the `deploy` hook. This way you can access the URL before the site accepts requests (unlike in the `post_deploy` hook). diff --git a/docs/src/configuration/app/troubleshoot-disks.md b/docs/src/configuration/app/troubleshoot-disks.md index a830f682a6..bcf02cf72c 100644 --- a/docs/src/configuration/app/troubleshoot-disks.md +++ b/docs/src/configuration/app/troubleshoot-disks.md @@ -32,7 +32,7 @@ you may receive a notification of low disk space. To solve this issue: -* [Check mount usage](#check-the-size-of-mounts) +* [Check mount usage](./troubleshoot-mounts.md#check-the-size-of-mounts) * [Check your database disk space](#check-your-database-disk-space) (if applicable) * [Increase the available disk space](#increase-available-disk-space) (if necessary) diff --git a/docs/src/configuration/services/headless-chrome.md b/docs/src/configuration/services/headless-chrome.md index 8b5cb09102..fd780d70dc 100644 --- a/docs/src/configuration/services/headless-chrome.md +++ b/docs/src/configuration/services/headless-chrome.md @@ -52,12 +52,12 @@ See how to [manage your Node.js version](../../languages/nodejs/node-version.md) {{% endpoint-description type="chrome-headless" /%}} -After configuration, include Puppeteer as a dependency in your `package.json`: +After configuration, include Puppeteer as a dependency: -```json +```json {location="package.json"} { "dependencies": { - "puppeteer": "^1.14.0" + "puppeteer": "^13.0.1" } } ``` @@ -74,7 +74,7 @@ const credentials = config.credentials('chromeheadlessbrowser'); and use them to define the `browserURL` parameter of `puppeteer.connect()` within an `async` function: ```js -exports.takeScreenshot = async function (url) { +exports.getBrowser = async function (url) { try { // Connect to chrome-headless using pre-formatted puppeteer credentials const formattedURL = config.formattedCredentials('chromeheadlessbrowser', 'puppeteer'); @@ -91,7 +91,7 @@ exports.takeScreenshot = async function (url) { }; ``` -Puppeteer allows your application to [create screenshots](https://pptr.dev/#?product=Puppeteer&version=v1.17.0&show=api-pagescreenshotoptions), [emulate a mobile device](https://pptr.dev/#?product=Puppeteer&version=v1.17.0&show=api-pageemulateoptions), [generate PDFs](https://pptr.dev/#?product=Puppeteer&version=v1.17.0&show=api-pagepdfoptions), and much more. +Puppeteer allows your application to [create screenshots](https://pptr.dev/#?product=Puppeteer&version=v13.0.1&show=api-pagescreenshotoptions), [emulate a mobile device](https://pptr.dev/#?product=Puppeteer&version=v13.0.1&show=api-pageemulateoptions), [generate PDFs](https://pptr.dev/#?product=Puppeteer&version=v13.0.1&show=api-pagepdfoptions), and much more. You can find some useful examples of using headless Chrome and Puppeteer on Platform.sh on the Community Portal: diff --git a/docs/src/configuration/services/mongodb.md b/docs/src/configuration/services/mongodb.md index b5c5010c76..9ea8d4a6bc 100644 --- a/docs/src/configuration/services/mongodb.md +++ b/docs/src/configuration/services/mongodb.md @@ -118,7 +118,7 @@ mongodump --port 30000 -u main -p main --authenticationDatabase main --db main As with any other shell command it can be piped to another command to compress the output or redirect it to a specific file. -For further references, see the [official `mongodump` documentation](https://docs.mongodb.com/manual/reference/program/mongodump/#bin.mongodump). +For further references, see the [official `mongodump` documentation](https://docs.mongodb.com/database-tools/mongodump/). ## Upgrading diff --git a/docs/src/configuration/services/mysql/_index.md b/docs/src/configuration/services/mysql/_index.md index 4f6195f3c6..7479322055 100644 --- a/docs/src/configuration/services/mysql/_index.md +++ b/docs/src/configuration/services/mysql/_index.md @@ -268,7 +268,7 @@ relationships: imports: "db:importer" ``` -These relationships are then available in the [`PLATFORM_RELATIONSHIPS` environment variable](#platform_relationships-reference). +These relationships are then available in the [`PLATFORM_RELATIONSHIPS` environment variable](#relationship-reference). Each has its own credentials you can use to connect to the given database. ## Configure the database diff --git a/docs/src/configuration/services/mysql/troubleshoot.md b/docs/src/configuration/services/mysql/troubleshoot.md index be92663b08..430225ec6e 100644 --- a/docs/src/configuration/services/mysql/troubleshoot.md +++ b/docs/src/configuration/services/mysql/troubleshoot.md @@ -69,7 +69,7 @@ to learn about low disk space before it becomes an issue. `MySQL server has gone awa` errors may be caused by the size of the database packets. If so, the logs may show warnings like `Error while sending QUERY packet` before the error. -One way to resolve the issue is to use the [`max_allowed_packet` parameter](./_index.md#adjusting-database-configuration). +One way to resolve the issue is to use the [`max_allowed_packet` parameter](./_index.md#configure-the-database). ### Worker timeout diff --git a/docs/src/configuration/services/network-storage.md b/docs/src/configuration/services/network-storage.md index 13b172e8d9..a951106791 100644 --- a/docs/src/configuration/services/network-storage.md +++ b/docs/src/configuration/services/network-storage.md @@ -48,7 +48,7 @@ The Network storage service is available on all regions except the legacy region * `us.platform.sh` If you're on one of those and require the service, -you should [migrate your project](/guides/general/region-migration.md#region-migration) to a newer region. +you should [migrate your project](../../guides/general/region-migration.md) to a newer region. ## Usage example diff --git a/docs/src/configuration/services/vault.md b/docs/src/configuration/services/vault.md index a94ad6e642..5a9b8aa92b 100644 --- a/docs/src/configuration/services/vault.md +++ b/docs/src/configuration/services/vault.md @@ -36,7 +36,9 @@ You can create multiple endpoints, such as to have key management separate from ## Use Vault KMS -To connect your app to the Vault KMS, use a token that is defined in the `$PLATFORM_RELATIONSHIPS` environment variable. With this token for authentication, you can use any of the policies you [defined in your `.platform/services.yaml` file](#add-the-service). +To connect your app to the Vault KMS, use a token that is defined in the `$PLATFORM_RELATIONSHIPS` environment variable. +With this token for authentication, +you can use any of the policies you [defined in your `.platform/services.yaml` file](#1-configure-the-service). The following examples use cURL as an example, which you could do in a hook or after SSHing into your app environment. Adapt the examples for your app's language. @@ -48,7 +50,7 @@ In order to make any calls to the Vault KMS, you need your token. Get it from th echo $PLATFORM_RELATIONSHIPS | base64 --decode | jq -r ".[0].password" ``` -`` is the name you [defined in your `.platform.app.yaml` file](#add-the-relationship). +`` is the name you [defined in your `.platform.app.yaml` file](#2-add-the-relationship). The `-r` flag returns the string itself, not wrapped in quotes. @@ -70,11 +72,11 @@ Assign it to a variable as follows: VAULT_URL=$(echo $PLATFORM_RELATIONSHIPS | base64 --decode | jq -r ".[0].host"):$(echo $PLATFORM_RELATIONSHIPS | base64 --decode | jq -r ".[0].port") ``` -`` is the name you [defined in your `.platform.app.yaml` file](#add-the-relationship). +`` is the name you [defined in your `.platform.app.yaml` file](#2-add-the-relationship). ### Manage your keys -Your key names are [defined in your `.platform/services.yaml` file](#add-the-service). You can manage them if you've set an [admin policy](#policies) for them. +Your key names are [defined in your `.platform/services.yaml` file](#1-configure-the-service). You can manage them if you've set an [admin policy](#policies) for them. To get information on a key, such as its expiration date, run the following command: diff --git a/docs/src/dedicated-gen-3/overview.md b/docs/src/dedicated-gen-3/overview.md index 41e6832c21..4f9bc9a844 100644 --- a/docs/src/dedicated-gen-3/overview.md +++ b/docs/src/dedicated-gen-3/overview.md @@ -25,7 +25,7 @@ For a PCI-compliant option, use a [previous-generation Dedicated Cluster](../ded ## Why a Generation 3? -Our existing [dedicated infrastructure](/dedicated/overview) ensures increased uptime and availability for your applications and services, but configuration or application topology changes have to go through our Customer Success team, as the VMs are provisioned by us. Generation 3 gives you both the high availability from our Dedicated offer combined with the self-service flexibility and features of Platform.sh Professional. +Our existing [dedicated infrastructure](../dedicated/overview) ensures increased uptime and availability for your applications and services, but configuration or application topology changes have to go through our Customer Success team, as the VMs are provisioned by us. Generation 3 gives you both the high availability from our Dedicated offer combined with the self-service flexibility and features of Platform.sh Professional. This means that you are able to edit your configuration yourself - in your `services.yaml`, `routes.yaml`, and `.platform.app.yaml` files - and then see those changes reflected in your Dedicated Generation 3 environments on every push without opening a ticket. @@ -33,7 +33,7 @@ This means that you are able to edit your configuration yourself - in your `serv * A minimum of three virtual machine cluster is associated with your default (production) environment, and also optionally with a staging environment. * Configuration changes on development environments (through your `services.yaml`, `routes.yaml`, and `.platform.app.yaml` files) are reflected on these Dedicated Gen 3 clusters when you merge them. It is not necessary to open a support ticket to change production infrastructure like it is on Dedicated. -* You can deploy your application in any of our [supported cloud providers](/development/faq.md#which-geographic-zones-does-platformsh-cover). +* You can deploy your application in any of our [supported cloud providers](../development/faq.md#which-geographic-zones-does-platformsh-cover). ## Differences from the Grid @@ -41,7 +41,7 @@ Although Dedication Generation 3 adds plenty of features to your existing Grid a ### Available services -In our [services documentation](/configuration/services) you will notice that not every service is available on Dedicated Generation 3 that is available on the Grid, nor is every version. The table below shows the currently available services and their versions for Dedicated Generation 3. +In our [services documentation](../configuration/services/_index.md) you will notice that not every service is available on Dedicated Generation 3 that is available on the Grid, nor is every version. The table below shows the currently available services and their versions for Dedicated Generation 3. {{< gen-3-services >}} @@ -51,7 +51,7 @@ Because you get a redundant infrastructure, note that local mounts will be local ## Setting up -If you are interested in Platform.sh's data cloning, environment control and infrastructure-as-code philisophy across our supported runtimes and services, but you also need a large amount of resources and data isolation, you can [contact us](https://platform.sh/contact) to start setting up a Dedicated Generation 3 project. +If you are interested in Platform.sh's data cloning, environment control and infrastructure-as-code philosophy across our supported runtimes and services, but you also need a large amount of resources and data isolation, you can [contact us](https://platform.sh/contact) to start setting up a Dedicated Generation 3 project. At this time, existing Platform.sh Professional projects cannot be migrated to Dedicated Generation 3, but they soon will be. Migrations will then require contacting our sales team, at which point your infrastructure will be reviewed for compatibility and pricing. After that, your existing project settings will be modified to set up a production environment using Dedicated Generation 3. diff --git a/docs/src/dedicated/overview/monitoring.md b/docs/src/dedicated/overview/monitoring.md index c0fbb9b0d9..2d4dee29a8 100644 --- a/docs/src/dedicated/overview/monitoring.md +++ b/docs/src/dedicated/overview/monitoring.md @@ -23,7 +23,7 @@ A third-party availability monitoring system is configured for every Dedicated p ## Application performance monitoring Platform.sh offers application performance monitoring (APM) packaged with infrastructure monitoring in the Platform.sh Observability Suite. -This APM relies on [Blackfire.io](../../integrations/observability/blackfire.md#on-a-dedicated-cluster), +This APM relies on [Blackfire.io](../../integrations/observability/blackfire.md#on-other-dedicated-infrastructure), which uniquely combines monitoring, profiling, and performance testing technologies. The Observability Suite is currently offered only to Enterprise, Elite, and Fleet customers. diff --git a/docs/src/development/cli/_index.md b/docs/src/development/cli/_index.md index ab1311f04b..6eaf9921e4 100644 --- a/docs/src/development/cli/_index.md +++ b/docs/src/development/cli/_index.md @@ -24,7 +24,7 @@ You need to have: You can also use another Bash-compatible shell such as [Git Bash](https://gitforwindows.org/), which you might have installed with git. -For full requirements, see the [requirements on GitHub](https://github.com/platformsh/platformsh-cli#requirements). +For full requirements, see the [requirements on GitHub](https://github.com/platformsh/platformsh-cli#user-content-requirements). ## 1. Install @@ -34,7 +34,7 @@ Install the CLI using this command: curl -fsS https://platform.sh/cli/installer | php ``` -If you run into issues or want to install manually, see the [installation instructions on GitHub](https://github.com/platformsh/platformsh-cli#installation). +If you run into issues or want to install manually, see the [installation instructions on GitHub](https://github.com/platformsh/platformsh-cli#user-content-installation). ## 2. Authenticate @@ -169,7 +169,7 @@ The code is only merged between environments remotely. You can customize how the CLI operates and what it returns with a configuration file (`.platform/local/project.yaml`) or environment variables. -For details, see the [customization instructions on GitHub](https://github.com/platformsh/platformsh-cli#customization). +For details, see the [customization instructions on GitHub](https://github.com/platformsh/platformsh-cli#user-content-customization). ### Autocomplete commands diff --git a/docs/src/development/email.md b/docs/src/development/email.md index 28e0e6b541..402717e584 100644 --- a/docs/src/development/email.md +++ b/docs/src/development/email.md @@ -44,7 +44,7 @@ To have DKIM enabled for your domain: {{< note>}} -The TXT record to include your account ID (see [SendGrid's SPF setup guidelines](https://docs.sendgrid.com/ui/account-and-settings/spf-records#custom-spf-records)) +The TXT record to include your account ID (see [SendGrid's SPF guidelines](https://docs.sendgrid.com/ui/account-and-settings/spf-records)) looks similar to the following: ```txt diff --git a/docs/src/development/faq.md b/docs/src/development/faq.md index 70dc0d3255..9812c3c1e4 100644 --- a/docs/src/development/faq.md +++ b/docs/src/development/faq.md @@ -45,7 +45,7 @@ you have four copies of your application, four copies of your database, four cop Yes! Platform.sh supports non-ephemeral storage. When you configure your application you can tell it what directories you want to be read/write. -(These are called [mounts](/configuration/app/app-reference.md#mounts).) +(These are called [mounts](../configuration/app/app-reference.md#mounts).) These are mounted on a distributed file system (which is transparent for you). When you backup your environment, they are backed up as well. When you create a new staging environment, @@ -72,7 +72,7 @@ Increasing your plan size increases the pool of CPU and RAM that gets split amon All containers on development plans are "small" containers. See configuration options for [apps](../configuration/app/app-reference.md#sizes) -and [services](../configuration/services/_index.md#sizes). +and [services](../configuration/services/_index.md#size). ## What exactly am I SSHing into? diff --git a/docs/src/development/local/lando.md b/docs/src/development/local/lando.md index 739f2eec8f..2f029bc8de 100644 --- a/docs/src/development/local/lando.md +++ b/docs/src/development/local/lando.md @@ -8,7 +8,8 @@ weight: 3 At this time, Lando supports only PHP-based applications but works with any service supported by Platform.sh. Support for other application languages is in progress. -See the [Lando documentation](https://docs.lando.dev/config/platformsh.html) for installing and setting up Lando on your system. A quick-start guide is included below, but the Lando documentation is the primary source of truth. +See the [Lando documentation](https://docs.lando.dev/platformsh/) for installing and setting up Lando on your system. +A quick-start guide is included below, but the Lando documentation is the primary source of truth. ## Quick start diff --git a/docs/src/development/sanitize-db.md b/docs/src/development/sanitize-db.md index fa9992089a..db86675530 100644 --- a/docs/src/development/sanitize-db.md +++ b/docs/src/development/sanitize-db.md @@ -21,7 +21,7 @@ You need: - A project with a [MySQL database](../configuration/services/mysql/_index.md). - A command interface installed: - With Drupal: [Drush](https://www.drush.org/latest/install/) - - Without Drupal: the [Platform CLI](/development/cli/_index.md#cli-command-line-interface) + - Without Drupal: the [Platform CLI](../development/cli/_index.md) This guide is about sanitizing MySQL databases. diff --git a/docs/src/development/ssh/_index.md b/docs/src/development/ssh/_index.md index 8a70b9b068..fc706e5674 100644 --- a/docs/src/development/ssh/_index.md +++ b/docs/src/development/ssh/_index.md @@ -34,7 +34,7 @@ The certificate is automatically cycled every hour for a new certificate as long If you are inactive for an extended period, your certificate expires and you are asked to login again the next time you use a command that requires authentication. -You are now ready to run CLI commands and to [connect to an environment](#connect-to-your-server-with-ssh). +You are now ready to run CLI commands and connect to an environment. ### 2. Connect to an app with SSH @@ -68,7 +68,7 @@ Now you can interact with the environment as you want. ## Connect to services -To connect to a service, you need the [service credentials](../../configuration/services/_index.md#obtain-service-credentials). +To connect to a service, you need the [service credentials](../../configuration/services/_index.md#1-obtain-service-credentials). Then you can connect either with a [direct tunnel](#use-a-direct-tunnel) or a [tunnel in your app](#use-an-app-tunnel). ### Use a direct tunnel @@ -90,7 +90,7 @@ Save encoded tunnel details to the PLATFORM_RELATIONSHIPS variable using: ``` Use the returned host (in this case `http://127.0.0.1:30000`) for your connection -and fill in the details with the rest of your [service credentials](../../configuration/services/_index.md#obtain-service-credentials). +and fill in the details with the rest of your [service credentials](../../configuration/services/_index.md#1-obtain-service-credentials). The `tunnel:open` command connects all relationships defined in your [app configuration](../../configuration/app/_index.md). To open only one connection when you have multiple relationships defined, run `tunnel:single`. @@ -115,7 +115,7 @@ The host is everything after the `@` and the username is what's before it. In this case, the host is `ssh.us.platform.sh` and the username is `jyu7waly36ncj-main-7rqtwti--app`. The host is the same for the entire project, while the username varies by environment. -To connect to a service, fill in the details with the rest of your [service credentials](../../configuration/services/_index.md#obtain-service-credentials). +To connect to a service, fill in the details with the rest of your [service credentials](../../configuration/services/_index.md#1-obtain-service-credentials). ## Alternative authentication methods diff --git a/docs/src/development/ssh/ssh-keys.md b/docs/src/development/ssh/ssh-keys.md index 1fe626e5f0..3be16def1d 100644 --- a/docs/src/development/ssh/ssh-keys.md +++ b/docs/src/development/ssh/ssh-keys.md @@ -54,7 +54,7 @@ To find your public key file: If you find a file ending in `.pub`, copy the location and [add it to your Platform.sh account](#2-add-an-ssh-key-to-your-platform-account). -If you don't find an existing key, [generate new keys](#generate-new-keys). +If you don't find an existing key, [generate new keys](#1b-generate-new-keys). ### 1B. Generate new keys diff --git a/docs/src/development/tools.md b/docs/src/development/tools.md index 1c371835c3..425cb893d8 100644 --- a/docs/src/development/tools.md +++ b/docs/src/development/tools.md @@ -23,4 +23,4 @@ Secure Shell (SSH) is a secure, encrypted connection between your computer and t Certificates are used automatically when you use the [Platform.sh CLI](/development/cli/_index.md) and run almost any command. You may force a login using `platform login -f` on the command line, provided you have a web browser available. -To use key pairs, see the [SSH page](/development/ssh/_index.md#authenticate-with-ssh-keys). +To use key pairs, see the [SSH keys](./ssh/ssh-keys.md). diff --git a/docs/src/development/troubleshoot.md b/docs/src/development/troubleshoot.md index 12db7143b4..d8755c4d94 100644 --- a/docs/src/development/troubleshoot.md +++ b/docs/src/development/troubleshoot.md @@ -163,7 +163,7 @@ Except where you define it, the file system is all read-only, with code changes This gives you benefits like repeatable deployments, consistent backups, and traceability. To generate anything you need later, [write to disk during a `build` hook](../configuration/app/app-reference.md#writable-directories-during-build). -Or [declare mounts](../configuration/app/app-reference.md#mounts#mounts), +Or [declare mounts](../configuration/app/app-reference.md#mounts), which are writable even during and after deploy. They can be used for your data: file uploads, logs, and temporary files. @@ -215,7 +215,7 @@ Here are a few tips that can help you find the exact cause. ### Check for errors in the logs -Invisible errors during the build and deploy phase can cause increased wait times, failed builds, and other problems. Investigate [each log](/development/logs.md#accessing-logs) and fix any errors you find. +Invisible errors during the build and deploy phase can cause increased wait times, failed builds, and other problems. Investigate [each log](./logs.md#container-logs) and fix any errors you find. ### Build and deploy hooks diff --git a/docs/src/development/variables/set-variables.md b/docs/src/development/variables/set-variables.md index 999ec0a038..8e7e31d5ce 100644 --- a/docs/src/development/variables/set-variables.md +++ b/docs/src/development/variables/set-variables.md @@ -79,7 +79,9 @@ When naming variables, be sure to take [variable prefixes](./_index.md#variable- ### Environment variable options -Environment variables share all of the [options available for project variables](./_index.md#variable-options), with the exception that visibility in the build and runtime can be set only with the CLI (not in the console). Environment variables have one additional option: +Environment variables share all of the [options available for project variables](#variable-options), +with the exception that visibility in the build and runtime can be set only with the CLI (not in the console). +Environment variables have one additional option: | Option | CLI flag | Default | Description | | ----------- | --------------- | ------- | ----------- | diff --git a/docs/src/development/variables/use-variables.md b/docs/src/development/variables/use-variables.md index 546df9d41d..ff8e7a2646 100644 --- a/docs/src/development/variables/use-variables.md +++ b/docs/src/development/variables/use-variables.md @@ -3,7 +3,7 @@ title: Use variables description: See how to use variables that have already been set so you can take control over your app's environment. --- -Get a list of all variables defined on a given environment in [the management console](/administration/web/configure-environment.md#variables) +Get a list of all variables defined on a given environment in [the management console](../../administration/web/configure-environment.md#variables) or use the CLI: ```bash @@ -360,7 +360,7 @@ and whether they're available during builds and at runtime. | `PLATFORM_SMTP_HOST` | No | Yes | The SMTP host to send email messages through. Is empty when mail is disabled for the current environment. | | `PLATFORM_SOURCE_DIR` | Yes | No | Equivalent to `PLATFORM_APP_DIR` in the context of a running [source operation](../../configuration/app/source-operations.md). The directory contains a writable copy of your repository that you can commit to during the operation. | | `PLATFORM_TREE_ID` | Yes | Yes | The ID of the tree the application was built from, essentially the SHA hash of the tree in Git. Use when you need a unique ID for each build. | -| `PLATFORM_VARIABLES` | Some | Some | A base64-encoded JSON object with all user-defined project and environment variables that don't use a [prefix](./_index.md#variable-prefixes). The keys are the variable names and the values are the variable values. Availability during builds and at runtime depends on the settings for each variable. See how to [access individual variables](#accessing-variables-in-a-shell). | +| `PLATFORM_VARIABLES` | Some | Some | A base64-encoded JSON object with all user-defined project and environment variables that don't use a [prefix](./_index.md#variable-prefixes). The keys are the variable names and the values are the variable values. Availability during builds and at runtime depends on the settings for each variable. See how to [access individual variables](#access-variables-in-a-shell). | | `PORT` | No | Yes | A `string` representing the port to which requests are sent if the [`web.upstream.socket_family` property](../../configuration/app/app-reference.md#upstream) is unset or set to `tcp`. | | `SOCKET` | No | Yes | A `string` representing the path to the Unix socket file to use if the [`web.upstream.socket_family` property](../../configuration/app/app-reference.md#upstream) is set to `unix`. | @@ -430,7 +430,7 @@ Some apps require configuration values to be specified in a static, non-executab and don't support reading from environment variables. To populate these files with variables you set yourself, -make sure the variables are set to be [visible at build time](./set-variables.md#environment-variables). +make sure the variables are set to be [visible at build time](./set-variables.md#variable-options). The files can't be populated with Platform.sh-provided variables not available at build time (such as `PLATFORM_RELATIONSHIPS`). You also can't write to them in a `deploy` hook as the file system is read only. diff --git a/docs/src/domains/cdn/_index.md b/docs/src/domains/cdn/_index.md index 33d8c5334a..19013db0f5 100644 --- a/docs/src/domains/cdn/_index.md +++ b/docs/src/domains/cdn/_index.md @@ -10,10 +10,10 @@ Our experience has shown that effective caching can mean a huge difference in th and that placing the caches closer to your users (wherever they may be) is the best solution currently available. Self-Service Grid plans do not include a CDN by default, but you are welcome to configure one yourself. -See our [guidelines](/bestpractices/http-caching.md) for when and if to use a CDN for HTTP caching. +See our [guidelines](../../bestpractices/http-caching.md) for when and if to use a CDN for HTTP caching. We have partnerships with a variety of CDN vendors depending on your application’s needs. -Our recommended CDN provider is [Fastly](/domains/cdn/fastly.md). +Our recommended CDN provider is [Fastly](./fastly.md). ## DNS management @@ -163,13 +163,13 @@ If your CDN offers this option, an alternative way of securing the connection is **note**: Remember to permit your developers to access the origin by creating your own certificate or else they won't be able to access the project URL directly (see below). -CloudFlare has [a very good article](https://support.cloudflare.com/hc/en-us/articles/204899617-Authenticated-Origin-Pulls) +CloudFlare has [a very good article](https://developers.cloudflare.com/ssl/origin-configuration/authenticated-origin-pull/) on what client authenticated TLS is and how to set this up. To activate authenticated TLS follow the following steps: - Download the correct certificate from your CDN provider. - - [CloudFlare](https://support.cloudflare.com/hc/en-us/article_attachments/360044928032/origin-pull-ca.pem) + - [CloudFlare](https://developers.cloudflare.com/ssl/static/authenticated_origin_pull_ca.pem) - *Caveat! an attacker could make a Cloudflare account to bypass your origin restriction. For CloudFlare, using the HTTP access control described above is the recommended way of securing your origin.* - [Fastly](https://docs.fastly.com/products/waf-tuning-plus-package#authenticated-tls-to-origin) - Make sure you have a `.crt` file. If you have a `.pem` file, rename it to `cdn.crt` diff --git a/docs/src/domains/checklist.md b/docs/src/domains/checklist.md index bef6689bec..3473891dd2 100644 --- a/docs/src/domains/checklist.md +++ b/docs/src/domains/checklist.md @@ -40,7 +40,7 @@ Also ensure that the data on the production instance is up to date and ready to ## 3. Optionally obtain a 3rd party TLS certificate Platform.sh automatically provides TLS certificates for all sites issued by [Let's Encrypt](https://letsencrypt.org/) at no charge. -[In most cases](../configuration/routes/https.md#limitations), this is sufficient and no further action is necessary. +[In most cases](../configuration/routes/https.md#limits), this is sufficient and no further action is necessary. However, if you want to use a [third-party TLS certificate](./steps/tls.md) to encrypt your production site, you can obtain one from any number of 3rd party TLS issuers. Platform.sh does not charge for using a 3rd party TLS certificate, although the issuer may. diff --git a/docs/src/domains/steps/_index.md b/docs/src/domains/steps/_index.md index a075a35606..09601697f8 100644 --- a/docs/src/domains/steps/_index.md +++ b/docs/src/domains/steps/_index.md @@ -103,16 +103,17 @@ After adding the line the file will look something like: ![Hosts File](/images/config-files/hosts-file.png "0.4") -Alternatively there is also an add-on for Firefox and Google Chrome +Alternatively, there's an add-on for Firefox that allows you to dynamically switch DNS IP addresses without modifying your `hosts` file. * [Firefox LiveHosts add-on](https://addons.mozilla.org/en-US/firefox/addon/livehosts/) -* [Google Chrome LiveHosts add-on](https://chrome.google.com/webstore/detail/livehosts/hdpoplemgeaioijkmoebnnjcilfjnjdi?hl=en) {{< note >}} -Do not put the IP address you see here, but the one you got from the ping command. + +Don't put the IP address you see here, but the one you got from the ping command. *Also, remember to remove this entry after you have configured DNS!* + {{< /note >}} Sometimes it can take Let's Encrypt a couple of minutes to provision the certificate the first time. diff --git a/docs/src/frameworks/ibexa/_index.md b/docs/src/frameworks/ibexa/_index.md index ce0b973b2f..131ef9e0e3 100644 --- a/docs/src/frameworks/ibexa/_index.md +++ b/docs/src/frameworks/ibexa/_index.md @@ -25,8 +25,7 @@ If you have an existing Ibexa DXP project that was upgraded from a previous vers In particular, see: * The [.platform.app.yaml](https://github.com/ezsystems/ezplatform/blob/master/.platform.app.yaml) file, which automatically builds Ibexa DXP in dev mode or production mode depending on your defined project-level variables. - * The [.platform](https://github.com/ezsystems/ezplatform/tree/master/.platform) directory - * The [platformsh.php](https://github.com/ezsystems/ezplatform/blob/master/config/packages/overrides/platformsh.php) configuration file, which does the work of mapping Platform.sh environment variables into Ibexa DXP. It also will automatically enable Redis-based cache and session support if detected. + * The [.platform](https://github.com/ezsystems/ezplatform/tree/master/.platform) directory. ## Local Development with eZ Platform 2.x and later @@ -116,7 +115,7 @@ The main ones are: * **Downstream database synchronization**: Getting it from the remote to the local. * **Downstream file storage synchronization**: Getting it from the remote to the local. -To help you with that, Platform.sh provides a CLI that you probably already have. If you don't, see the [install guide](/development/cli/_index.md#installation). +To help you with that, Platform.sh provides a CLI that you can [install](../../development/cli/_index.md). Combined together, eZ Launchpad and Platform.sh CLI make those actions straight forward and simple. @@ -131,5 +130,9 @@ platform mount:download -m ezplatform/web/var --target=ezplatform/web/var/ -y The two first lines get the remote database and storage from the remote environment and stores it locally in `data/`. The third tells to eZ Launchpad to import those data in the Docker stack. {{< note >}} -The storage (images and files) synchronization is optional. Ibexa DXP provides a [placeholder generator mechanism](https://doc.ibexa.co/en/latest/guide/images/#setting-placeholder-generator) which allows you to forget about the real images for your local. + +The storage (images and files) synchronization is optional. +Ibexa DXP provides a [placeholder generator mechanism](https://doc.ibexa.co/en/latest/guide/images/#generate-placeholder-images) +that allows you to forget about the real images for your local. + {{< /note >}} diff --git a/docs/src/frameworks/ibexa/fastly.md b/docs/src/frameworks/ibexa/fastly.md index 544b4101d0..36a2882421 100644 --- a/docs/src/frameworks/ibexa/fastly.md +++ b/docs/src/frameworks/ibexa/fastly.md @@ -27,7 +27,7 @@ In order to use Fastly, Varnish must be disabled: ## Setting up Ibexa DXP to use Fastly -Ibexa DXP's documentation includes instructions on how to [configure Ibexa DXP for Fastly](https://doc.ibexa.co/en/latest/guide/http_cache/#using-fastly-as-httpcache-proxy). +Ibexa DXP's documentation includes instructions on how to [configure Ibexa DXP for Fastly](https://doc.ibexa.co/en/latest/guide/cache/symfony_reverse_proxy/#use-varnish-or-fastly). Follow the steps there to prepare Ibexa DXP for Fastly. ## Set credentials on Platform.sh diff --git a/docs/src/frameworks/jakarta.md b/docs/src/frameworks/jakarta.md index e91aede760..d25d7f4925 100644 --- a/docs/src/frameworks/jakarta.md +++ b/docs/src/frameworks/jakarta.md @@ -395,7 +395,7 @@ public class TransactionInterceptor { } ``` -Furthermore, Apache Delta Spike has a [post](https://deltaspike.apache.org/documentation/jpa.html#ExtendedPersistenceContexts) for treating this problem. +To treat this issue, see the [Apache Delta Spike docs](https://deltaspike.apache.org/documentation/jpa.html#_extended_persistence_contexts). ## Templates diff --git a/docs/src/gettingstarted/introduction/own-code/app-configuration.md b/docs/src/gettingstarted/introduction/own-code/app-configuration.md index 2579913f83..3bea50ce1e 100644 --- a/docs/src/gettingstarted/introduction/own-code/app-configuration.md +++ b/docs/src/gettingstarted/introduction/own-code/app-configuration.md @@ -65,7 +65,10 @@ The `.platform.app.yaml` file is extremely flexible, and can contain many lines * `name`: The [name of your application](../../../configuration/app/app-reference.md) container does not have to be the same as your project name, and in most single application cases you can simply name it `app`. You should notice in the next step, when you configure how requests are handled in `.platform/routes.yaml` that `name` is reused there, and it is important that they are the same. {{< note >}} - If you are trying to to deploy [microservices](/configuration/app/multi-app.md#example-of-a-micro-service-multi-app), the only constraint is that each of these application names must be unique. + + If you are trying to deploy microservices, + the only constraint is that each app name must be unique. + {{< /note >}} * `type`: The [type](/configuration/app/app-reference.md) attribute in `.platform.app.yaml` sets the container base image for the application, and sets the primary language. In general, `type` should have the form diff --git a/docs/src/gettingstarted/next-steps/going-live/first-steps.md b/docs/src/gettingstarted/next-steps/going-live/first-steps.md index 3212766d43..4e3d5bcfd5 100644 --- a/docs/src/gettingstarted/next-steps/going-live/first-steps.md +++ b/docs/src/gettingstarted/next-steps/going-live/first-steps.md @@ -21,7 +21,7 @@ Before you take your site live, there are a few steps that will help you prepare 3. **(Optional) Obtain 3rd party SSL if needed** Let's Encrypt SSL certificates are automatically issued for Platform.sh projects at no charge to you. - The number of Let's Encrypt certificates [is limited](../../../configuration/routes/https.md#limitations). + The number of Let's Encrypt certificates [is limited](../../../configuration/routes/https.md#limits). If you want to use a [third-party SSL certificate](../../../domains/steps/tls.md) instead, make sure that you have purchased it and that it's active prior to going live. diff --git a/docs/src/guides/drupal9/deploy/configure.md b/docs/src/guides/drupal9/deploy/configure.md index e1aa22976d..f891ea0af2 100644 --- a/docs/src/guides/drupal9/deploy/configure.md +++ b/docs/src/guides/drupal9/deploy/configure.md @@ -22,7 +22,7 @@ although you can also use Oracle MySQL or [PostgreSQL](/configuration/services/p We also strongly recommend using [Redis](/configuration/services/redis.md) for Drupal caching. Drupal's cache can be very aggressive, and keeping that data out of the database helps with both performance and disk usage. -Our Drupal template comes [pre-configured to use Redis](https://github.com/platformsh-templates/drupal9#customizations) for caching. +Our Drupal template comes [pre-configured to use Redis](https://github.com/platformsh-templates/drupal9#user-content-customizations) for caching. {{% /guides/config-service %}} diff --git a/docs/src/guides/drupal9/simplesaml.md b/docs/src/guides/drupal9/simplesaml.md index a2fce4d949..11bedbbe1f 100644 --- a/docs/src/guides/drupal9/simplesaml.md +++ b/docs/src/guides/drupal9/simplesaml.md @@ -126,7 +126,12 @@ if (isset($_ENV['PLATFORM_PROJECT_ENTROPY'])) { ## Generate SSL certificates (optional) -Depending on your Identity Provider (IdP), you may need to generate an [SSL/TLS certificate](https://hosting.review/web-hosting-glossary/#12) to connect to the Service Provider (SP). If so, you should generate the certificate locally following the instructions in the [SimpleSAMLphp documentation](https://simplesamlphp.org/docs/stable/simplesamlphp-sp). Whatever your resulting idP file is should be placed in the simplesamlphp/metadata directory. The certificate should be placed in the `simplesamlphp/cert` directory. (Create it if needed.) +Depending on your Identity Provider (IdP), +you may need to generate an SSL/TLS certificate to connect to the service provider. +If so, you should generate the certificate locally following the instructions in the [SimpleSAMLphp documentation](https://simplesamlphp.org/docs/latest/simplesamlphp-sp). +Your resulting IdP file is should be placed in the `simplesamlphp/metadata` directory. +The certificate should be placed in the `simplesamlphp/cert` directory. +(Create it if needed.) Then add the following line to your `simplesamlphp/config/config.php` file to tell the library where to find the certificate: diff --git a/docs/src/guides/drupal9/solr.md b/docs/src/guides/drupal9/solr.md index a8987c5922..cac37c26a0 100644 --- a/docs/src/guides/drupal9/solr.md +++ b/docs/src/guides/drupal9/solr.md @@ -37,7 +37,7 @@ Once [this issue](https://www.drupal.org/project/drupal/issues/2876675) is resol If you are using the latest version of Search API Solr and running Drupal 8.8 or higher on PHP 7.2 or higher, this step is no longer necessary. You should be able to proceed directly to the next step. -{{% endpoint-description type="solr" sectionLink="#solr-6-and-later" multipleText="cores" noApp=true /%}} +{{% endpoint-description type="solr" sectionLink="/configuration/services/solr.html#solr-6-and-later" multipleText="cores" noApp=true /%}} ### 4. Configure the server core diff --git a/docs/src/guides/gatsby/headless/drupal.md b/docs/src/guides/gatsby/headless/drupal.md index 8eb13e19c7..469ca1ca3b 100644 --- a/docs/src/guides/gatsby/headless/drupal.md +++ b/docs/src/guides/gatsby/headless/drupal.md @@ -49,7 +49,7 @@ You can then modify [`gatsby-config.js`](https://www.gatsbyjs.com/docs/reference The template file that defines how a single Drupal article should be formatted on Gatsby, retrieving the data from that article using the `nodeArticle` GraphQL query. -- [`gatsby/src/pages/articles.js`](https://github.com/platformsh-templates/gatsby-strapi/blob/master/gatsby/src/pages/articles.js) +- [`gatsby/src/pages/articles.js`](https://github.com/platformsh-templates/gatsby-strapi/blob/master/gatsby/src/components/articles.js) Retrieves all of Drupal's content to generate a list of articles at `/articles` on the Gatsby site using the `allNodeArticle` GraphQL query. @@ -57,7 +57,9 @@ You can then modify [`gatsby-config.js`](https://www.gatsbyjs.com/docs/reference {{< guides/gatsby/headless-postinstall name="Drupal">}} -After you have completed the installation you will need to enable the JSON API and Gatsby related modules, and then set up aliases for your articles using Pathauto. See [the post-installation](https://github.com/platformsh-templates/gatsby-drupal#post-install) instructions on the template for the detailed instructions. +After you have completed the installation, you need to enable the JSON API and Gatsby related modules +and then set up aliases for your articles using `pathauto`. +For detailed instructions, see the template's [post-installation instructions](https://github.com/platformsh-templates/gatsby-drupal#user-content-post-install). {{< /guides/gatsby/headless-postinstall >}} @@ -81,5 +83,4 @@ With Gatsby now deployed and pulling content from a backend Drupal application, If you replicate the `web.commands.start` block in Gatsby's `.platform.app.yaml` file above, you will be able to enable incremental builds on your projects. Once you save an update to a piece of Drupal content on a non-production branch, Drupal will place a request to a dedicated `/__refresh` endpoint on Gatsby (which is itself enabled by a [branch-dependent environment variable](https://github.com/platformsh-templates/gatsby-drupal/blob/master/gatsby/.environment)). Since Gatsby is running a development server on this non-production environment, this call will cause Gatsby to retrieve content from Drupal once again, resulting in a near instantly updated article on the frontend. -The process of enabling this feature is a little detailed, so it is best to consult the [template's README](https://github.com/platformsh-templates/gatsby-drupal#enabling-gatsby-live-preview-manual-configuration) for the most up-to-date instructions for how to do so. - +The process of enabling this feature is a little detailed, so it is best to consult the [template's README](https://github.com/platformsh-templates/gatsby-drupal#user-content-enabling-gatsby-live-preview-manual-configuration) for the most up-to-date instructions for how to do so. diff --git a/docs/src/guides/gatsby/headless/strapi.md b/docs/src/guides/gatsby/headless/strapi.md index d7d938bf70..c7ed923a31 100644 --- a/docs/src/guides/gatsby/headless/strapi.md +++ b/docs/src/guides/gatsby/headless/strapi.md @@ -33,7 +33,7 @@ $ yarn add strapi-plugin-graphql {{< guides/gatsby/headless-gatsby name="Strapi" template="gatsby-strapi" >}} -You can then modify [`gatsby-config.js`](https://www.gatsbyjs.com/docs/reference/config-files/gatsby-config/) to read from the backend Strapi container through the `strapi` relationship defined above to configure the `apiURL` attribute for `gatsby-source-strapi`. Notice that the source plugin requires that you explicitly define the `contentTypes` you would like to retrieve from Strapi. At this point you have not built out the API, and the Content Types `article` and `category` are included to support the [post-install instructions](https://github.com/platformsh-templates/gatsby-strapi/tree/update#post-install) outlined in the template's README. Adjust these values to fit your current API if your are planning on migrating an existing Strapi repository. +You can then modify [`gatsby-config.js`](https://www.gatsbyjs.com/docs/reference/config-files/gatsby-config/) to read from the backend Strapi container through the `strapi` relationship defined above to configure the `apiURL` attribute for `gatsby-source-strapi`. Notice that the source plugin requires that you explicitly define the `contentTypes` you would like to retrieve from Strapi. At this point you have not built out the API, and the Content Types `article` and `category` are included to support the [post-install instructions](https://github.com/platformsh-templates/gatsby-strapi/tree/update#user-content-post-install) outlined in the template's README. Adjust these values to fit your current API if your are planning on migrating an existing Strapi repository. {{< /guides/gatsby/headless-gatsby >}} @@ -57,7 +57,7 @@ You can then modify [`gatsby-config.js`](https://www.gatsbyjs.com/docs/reference {{< guides/gatsby/headless-postinstall name="Strapi">}} -After you have deployed, you will need to set up Strapi's Admin Panel and some initial content endpoints for the Gatsby frontend to consume. Create your admin user at the `backend` subdomain for Strapi. You can then follow the [template's post-install instructions](https://github.com/platformsh-templates/gatsby-strapi/tree/update#post-install) to setup up some initial `Article` and `Category` content endpoints. The API you develop there will be only accessible by admins by default, so be sure to adjust the permissions to public so Gatsby can access it. +After you have deployed, you will need to set up Strapi's Admin Panel and some initial content endpoints for the Gatsby frontend to consume. Create your admin user at the `backend` subdomain for Strapi. You can then follow the [template's post-install instructions](https://github.com/platformsh-templates/gatsby-strapi/tree/update#user-content-post-install) to setup up some initial `Article` and `Category` content endpoints. The API you develop there will be only accessible by admins by default, so be sure to adjust the permissions to public so Gatsby can access it. {{< /guides/gatsby/headless-postinstall >}} diff --git a/docs/src/guides/general/default-branch.md b/docs/src/guides/general/default-branch.md index 5dde41cb2e..efe2e8177a 100644 --- a/docs/src/guides/general/default-branch.md +++ b/docs/src/guides/general/default-branch.md @@ -10,7 +10,7 @@ To change it after project creation, follow the steps below. You can complete some of these steps through the management console, but since all can be completed with the CLI those commands alone are listed. -Be sure to [install the CLI](/development/cli/_index.md#installation) if you have not already done so. +Be sure to [install the CLI](../../development/cli/_index.md) if you have not already done so. It's assumed you are changing the default branch of your project on Platform.sh from `master` to `main`. If using another name for the default branch, update the commands accordingly. @@ -229,8 +229,8 @@ Platform.sh supports external Git integrations to a number of services, so follow the linked instructions below for changing the default branch to `main` for your provider: - [GitHub](https://github.com/github/renaming) -- [GitLab](https://docs.gitlab.com/ee/user/project/repository/branches/#default-branch) -- [BitBucket](https://community.atlassian.com/t5/Bitbucket-questions/How-to-change-MAIN-branch-in-BitBucket/qaq-p/977418#:~:text=In%20Bitbucket%20Cloud%2C%20please%20go,repository%20details%20%3E%3E%20Main%20branch.) +- [GitLab](https://docs.gitlab.com/ee/user/project/repository/branches/default.html#change-the-default-branch-name-for-a-project) +- [BitBucket](https://community.atlassian.com/t5/Bitbucket-questions/How-to-change-MAIN-branch-in-BitBucket/qaq-p/977418) ### 4. Deactivate the `master` environment diff --git a/docs/src/guides/quarkus/elasticsearch.md b/docs/src/guides/quarkus/elasticsearch.md index 803970b96d..d2025ccf99 100644 --- a/docs/src/guides/quarkus/elasticsearch.md +++ b/docs/src/guides/quarkus/elasticsearch.md @@ -38,7 +38,7 @@ export JAVA_OPTS="-Xmx$(jq .info.limits.memory /run/config.json)m -XX:+ExitOnOut ``` {{< note title="Tip" >}} -Environment variables names are following the conversion rules of [Eclipse MicroProfile](https://github.com/eclipse/microprofile-config/blob/master/spec/src/main/asciidoc/configsources.asciidoc#default-configsources). +Environment variables names are following the conversion rules of [Eclipse MicroProfile](https://github.com/eclipse/microprofile-config/blob/master/spec/src/main/asciidoc/configsources.asciidoc#user-content-default-configsources). {{< /note >}} ## 4. Connect to Elasticsearch diff --git a/docs/src/guides/quarkus/jpa.md b/docs/src/guides/quarkus/jpa.md index bf998dff0a..40e81cee25 100644 --- a/docs/src/guides/quarkus/jpa.md +++ b/docs/src/guides/quarkus/jpa.md @@ -40,7 +40,7 @@ export JAVA_OPTS="-Xmx$(jq .info.limits.memory /run/config.json)m -XX:+ExitOnOut ``` {{< note title="Tip" >}} -Environment variables names are following the conversion rules of [Eclipse MicroProfile](https://github.com/eclipse/microprofile-config/blob/master/spec/src/main/asciidoc/configsources.asciidoc#default-configsources). +Environment variables names are following the conversion rules of [Eclipse MicroProfile](https://github.com/eclipse/microprofile-config/blob/master/spec/src/main/asciidoc/configsources.asciidoc#user-content-default-configsources). {{< /note >}} ## 4. Connect to the service diff --git a/docs/src/guides/quarkus/mongodb.md b/docs/src/guides/quarkus/mongodb.md index f3d0de3af5..3a21eec2d9 100644 --- a/docs/src/guides/quarkus/mongodb.md +++ b/docs/src/guides/quarkus/mongodb.md @@ -47,7 +47,7 @@ export JAVA_OPTS="-Xmx$(jq .info.limits.memory /run/config.json)m -XX:+ExitOnOut ``` {{< note title="Tip" >}} -Environment variables names are following the conversion rules of [Eclipse MicroProfile](https://github.com/eclipse/microprofile-config/blob/master/spec/src/main/asciidoc/configsources.asciidoc#default-configsources). +Environment variables names are following the conversion rules of [Eclipse MicroProfile](https://github.com/eclipse/microprofile-config/blob/master/spec/src/main/asciidoc/configsources.asciidoc#user-content-default-configsources). {{< /note >}} ## 4. Connect to the service diff --git a/docs/src/guides/quarkus/panache.md b/docs/src/guides/quarkus/panache.md index c65571ad1e..7d439c041c 100644 --- a/docs/src/guides/quarkus/panache.md +++ b/docs/src/guides/quarkus/panache.md @@ -12,12 +12,12 @@ Hibernate ORM is the de facto JPA implementation and offers you the full breadth To activate Hibernate Panache and then have it accessed by the Quarkus application already in Platform.sh, it is necessary to modify two files. {{< note >}} -This guide only covers the *addition* of a service configuration to an existing Quarkus project already configured to deploy on Platform.sh. Please see the [deployment guide](/guides/quarkus/deploy/_index.md) for more detailed instructions for setting up app containers and initial projects. +This guide only covers the *addition* of a service configuration to an existing Quarkus project already configured to deploy on Platform.sh. Please see the [deployment guide](./deploy/_index.md) for more detailed instructions for setting up app containers and initial projects. {{< /note >}} ## 1. Add a SQL database service -In your [service configuration](../../configuration/services/_index.md), include a SQL database service. Make sure to visit the documentation for [that service](/configuration/services/_index.md) to find a valid version. For PostgreSQL that would look like: +In your [service configuration](../../configuration/services/_index.md), include a SQL database service. Make sure to visit the documentation for [that service](../../configuration/services/_index.md) to find a valid version. For PostgreSQL that would look like: {{< readFile file="src/registry/images/examples/full/postgresql.services.yaml" highlight="yaml" location=".platform/services.yaml" >}} @@ -42,7 +42,7 @@ export JAVA_OPTS="-Xmx$(jq .info.limits.memory /run/config.json)m -XX:+ExitOnOut ``` {{< note title="Tip" >}} -Environment variables names are following the conversion rules of [Eclipse MicroProfile](https://github.com/eclipse/microprofile-config/blob/master/spec/src/main/asciidoc/configsources.asciidoc#default-configsources). +Environment variables names are following the conversion rules of [Eclipse MicroProfile](https://github.com/eclipse/microprofile-config/blob/master/spec/src/main/asciidoc/configsources.asciidoc#user-content-default-configsources). {{< /note >}} ## 4. Connect to the service diff --git a/docs/src/guides/quarkus/redis.md b/docs/src/guides/quarkus/redis.md index 4ce46ffeb7..d74c1db564 100644 --- a/docs/src/guides/quarkus/redis.md +++ b/docs/src/guides/quarkus/redis.md @@ -38,7 +38,7 @@ export JAVA_OPTS="-Xmx$(jq .info.limits.memory /run/config.json)m -XX:+ExitOnOut ``` {{< note title="Tip" >}} -Environment variables names are following the conversion rules of [Eclipse MicroProfile](https://github.com/eclipse/microprofile-config/blob/master/spec/src/main/asciidoc/configsources.asciidoc#default-configsources). +Environment variables names are following the conversion rules of [Eclipse MicroProfile](https://github.com/eclipse/microprofile-config/blob/master/spec/src/main/asciidoc/configsources.asciidoc#user-content-default-configsources). {{< /note >}} ## 4. Connect to Redis diff --git a/docs/src/guides/spring/deploy/customize.md b/docs/src/guides/spring/deploy/customize.md index 192344a847..65e4ee0c2c 100644 --- a/docs/src/guides/spring/deploy/customize.md +++ b/docs/src/guides/spring/deploy/customize.md @@ -31,7 +31,11 @@ compile group: 'sh.platform', name: 'config', version: '2.2.2' ## `.environment` -The `.platform.app.yaml` file on the [previous page](/guides/spring/deploy/configure.md#application-container-platformappyaml) has been pulled directly from the [Spring template](https://github.com/platformsh-templates/spring-mvc-maven-mongodb/blob/master/.platform.app.yaml). It is sufficient to deploy Spring on it's own, but since [Spring Config](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config-relaxed-binding-from-environment-variables) makes it possible to overwrite configurations without impacting the application itself, you might elect to rely more heavily on environment variables in it's place. +The `.platform.app.yaml` file in the [previous step](./configure.md#application-container-platformappyaml) +has been pulled directly from the [Spring template](https://github.com/platformsh-templates/spring-mvc-maven-mongodb/blob/master/.platform.app.yaml). +It is sufficient to deploy Spring on its own, but since [Spring Config](https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables) +makes it possible to overwrite configurations without impacting the application itself, +you might elect to rely more heavily on environment variables in its place. Consider this simplified `.platform.app.yaml` file: diff --git a/docs/src/guides/spring/elasticsearch.md b/docs/src/guides/spring/elasticsearch.md index 798a4079ca..b188e9dc94 100644 --- a/docs/src/guides/spring/elasticsearch.md +++ b/docs/src/guides/spring/elasticsearch.md @@ -37,7 +37,9 @@ export JAVA_OPTS="-Xmx$(jq .info.limits.memory /run/config.json)m -XX:+ExitOnOut ``` {{< note title="Tip" >}} -Please check the [Spring Common Application properties](https://docs.spring.io/spring-boot/docs/current/reference/html/appendix-application-properties.html#common-application-properties) and the [Binding from Environment Variables](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config-relaxed-binding-from-environment-variables) to have access to more credentials options. + +{{% spring-common-props %}} + {{< /note >}} ## 4. Connect to Elasticsearch diff --git a/docs/src/guides/spring/jpa.md b/docs/src/guides/spring/jpa.md index a59462ce94..a29ae59db7 100644 --- a/docs/src/guides/spring/jpa.md +++ b/docs/src/guides/spring/jpa.md @@ -40,9 +40,12 @@ export JAVA_OPTS="-Xmx$(jq .info.limits.memory /run/config.json)m -XX:+ExitOnOut ``` {{< note title="Tip" >}} -Please check the [Spring Common Application properties](https://docs.spring.io/spring-boot/docs/current/reference/html/appendix-application-properties.html#common-application-properties) and the [Binding from Environment Variables](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config-relaxed-binding-from-environment-variables) to have access to more credentials options. + +{{% spring-common-props %}} + {{< /note >}} ## 4. Connect to the service -Commit that code and push. The specified cluster will now always point to the PostgreSQL or any SQL service that you wish. \ No newline at end of file +Commit that code and push. +The specified cluster now always points to the PostgreSQL or any SQL service that you wish. diff --git a/docs/src/guides/spring/mongodb.md b/docs/src/guides/spring/mongodb.md index a2038d7a75..5d43f9908a 100644 --- a/docs/src/guides/spring/mongodb.md +++ b/docs/src/guides/spring/mongodb.md @@ -42,7 +42,9 @@ export JAVA_OPTS="-Xmx$(jq .info.limits.memory /run/config.json)m -XX:+ExitOnOut ``` {{< note title="Tip" >}} -Please check the [Spring Common Application properties](https://docs.spring.io/spring-boot/docs/current/reference/html/appendix-application-properties.html#common-application-properties) and the [Binding from Environment Variables](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config-relaxed-binding-from-environment-variables) to have access to more credentials options. + +{{% spring-common-props %}} + {{< /note >}} ## 4. Connect to the service diff --git a/docs/src/guides/spring/redis.md b/docs/src/guides/spring/redis.md index 9b7cef98ba..f581d0ec8d 100644 --- a/docs/src/guides/spring/redis.md +++ b/docs/src/guides/spring/redis.md @@ -15,7 +15,8 @@ This guide only covers the *addition* of a service configuration to an existing ## 1. Add the Redis service -In your [service configuration](../../configuration/services/_index.md), include Persistent Redis with a [valid supported version](/configuration/services/redis.md#persistent-redis): +In your [service configuration](../../configuration/services/_index.md), +include persistent Redis with a [valid supported version](../../configuration/services/redis.md#persistent-redis): {{< readFile file="src/registry/images/examples/full/redis-persistent.services.yaml" highlight="yaml" location=".platform/services.yaml" >}} @@ -36,7 +37,9 @@ export JAVA_OPTS="-Xmx$(jq .info.limits.memory /run/config.json)m -XX:+ExitOnOut ``` {{< note title="Tip" >}} -Please check the [Spring Common Application properties](https://docs.spring.io/spring-boot/docs/current/reference/html/appendix-application-properties.html#common-application-properties) and the [Binding from Environment Variables](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config-relaxed-binding-from-environment-variables) to have access to more credentials options. + +{{% spring-common-props %}} + {{< /note >}} ## 4. Connect to Redis diff --git a/docs/src/guides/typo3/deploy/configure.md b/docs/src/guides/typo3/deploy/configure.md index 9ac622eb09..d4bd07f798 100644 --- a/docs/src/guides/typo3/deploy/configure.md +++ b/docs/src/guides/typo3/deploy/configure.md @@ -20,7 +20,7 @@ description: | We recommend the latest [MariaDB](/configuration/services/mysql/_index.md) version for TYPO3, although you can also use Oracle MySQL or [PostgreSQL](/configuration/services/postgresql.md) if you prefer. We also strongly recommend using [Redis](/configuration/services/redis.md) for TYPO3 caching. -Our TYPO3 template comes [pre-configured to use Redis](https://github.com/platformsh-templates/typo3#customizations) for caching. +Our TYPO3 template comes [pre-configured to use Redis](https://github.com/platformsh-templates/typo3#user-content-customizations) for caching. {{% /guides/config-service %}} @@ -32,7 +32,7 @@ Our TYPO3 template comes [pre-configured to use Redis](https://github.com/platfo Note that the command `php vendor/bin/typo3cms install:generatepackagestate` is run during the build hook. The command ensures all installed extensions are enabled -and that they can be omitted if you commit your own [`PackageStates.php` file](https://docs.typo3.org/m/typo3/reference-coreapi/master/en-us/ExtensionArchitecture/ExtensionManagement/Index.html#package-manager). +and that they can be omitted if you commit your own [`PackageStates.php` file](https://docs.typo3.org/m/typo3/reference-coreapi/master/en-us/ExtensionArchitecture/ExtensionManagement/Index.html#installing-extensions). {{< /guides/config-app >}} diff --git a/docs/src/guides/wordpress/composer/migrate.md b/docs/src/guides/wordpress/composer/migrate.md index bbfe685089..d454e48954 100644 --- a/docs/src/guides/wordpress/composer/migrate.md +++ b/docs/src/guides/wordpress/composer/migrate.md @@ -92,7 +92,11 @@ Like WordPress core itself, themes and plugins can be installed as dependencies 1. **Configure the WPPackagist repository** - When you download dependencies using Composer, you will by default retrieve them through [Packagist](https://packagist.org), which is the primary Composer repository for public PHP packages. In the previous section, you installed WordPress core through this repository. Some themes and plugins for WordPress are also on Packagist, but most of them are accessible through a similar service specific to Wordpress called [WPackagist](https://wpackagist). + When you download dependencies using Composer, you by default retrieve them through [Packagist](https://packagist.org), + which is the primary Composer repository for public PHP packages. + In the previous section, you installed WordPress core through this repository. + Some themes and plugins for WordPress are also on Packagist, + but most of them are accessible through a similar service specific to WordPress called [WPackagist](https://wpackagist.org). In order to pull from this repository, you'll need to add WPackagist to your `composer.json` file so that Composer knows to look for packages there. Run the command: @@ -137,7 +141,7 @@ Like WordPress core itself, themes and plugins can be installed as dependencies 3. **Install themes and modules** - Search for your existing themes and plugins [WPackagist](https://wpackagist) and install them through Composer with `composer require`: + Search for your existing themes and plugins [WPackagist](https://wpackagist.org) and install them through Composer with `composer require`: ```bash # Plugin diff --git a/docs/src/integrations/observability/new-relic/php.md b/docs/src/integrations/observability/new-relic/php.md index d70e034aba..5d22c1e110 100644 --- a/docs/src/integrations/observability/new-relic/php.md +++ b/docs/src/integrations/observability/new-relic/php.md @@ -3,7 +3,7 @@ title: "PHP" --- New Relic isn't yet available on PHP 8.1. -To use New Relic with PHP, specify `type: 'php:8.0'` or lower in your [app configuration](../../../configuration/app/app-reference.md#type). +To use New Relic with PHP, specify `type: 'php:8.0'` or lower in your [app configuration](../../../configuration/app/app-reference.md#types). ## Get your license key diff --git a/docs/src/integrations/source/bitbucket.md b/docs/src/integrations/source/bitbucket.md index 70e9f3f7f1..808180f7a8 100644 --- a/docs/src/integrations/source/bitbucket.md +++ b/docs/src/integrations/source/bitbucket.md @@ -8,8 +8,8 @@ description: | It's possible to integrate a Platform.sh project with either the freely available Bitbucket Cloud product or with the self-hosted [Bitbucket Server](https://confluence.atlassian.com/bitbucketserver/). -In both cases, you need to [install the Platform.sh CLI](/development/cli/_index.md#installation), if you haven't already done so, -to set up the integration. +In both cases, you need to [install the Platform.sh CLI](/development/cli/_index.md), +if you haven't already done so, to set up the integration. {{< note >}} @@ -127,14 +127,4 @@ even if specifically set to true. {{< /note >}} -## Clones and commits - -You can clone your codebase by running `platform get ` -or in your project in the console by going to Code > Git and running the `git clone` command. - -When you perform this action, you are actually cloning from your remote integrated repository, -so long as you have the [appropriate access to do so](/administration/users.md#user-access-and-integrations). - -Your Bitbucket repository is considered by Platform.sh to be the "source of truth" for the project. -The project is only a mirror of that repository and all commits should be pushed only to Bitbucket. - +{{% clone-commit name="Bitbucket" %}} diff --git a/docs/src/integrations/source/github.md b/docs/src/integrations/source/github.md index 6aec395478..1c7db4e648 100644 --- a/docs/src/integrations/source/github.md +++ b/docs/src/integrations/source/github.md @@ -115,13 +115,4 @@ they will be activated automatically with a copy of the parent's data. However, environments based on (non-pull-request) **branches** cannot have parents; they will inherit directly from the default branch and start inactive by default. -## Clones and commits - -You can clone your codebase by running `platform get ` -or in your project in the console by going to Code > Git and running the `git clone` command. - -When you perform this action, you are actually cloning from your remote integrated repository, -so long as you have the [appropriate access to do so](/administration/users.md#user-access-and-integrations). - -Your GitHub repository is considered by Platform.sh to be the "source of truth" for the project. -The project is only a mirror of that repository, and all commits should be pushed only to GitHub. +{{% clone-commit name="GitHub" %}} diff --git a/docs/src/integrations/source/gitlab.md b/docs/src/integrations/source/gitlab.md index b6be2d1969..e9225ee1c7 100644 --- a/docs/src/integrations/source/gitlab.md +++ b/docs/src/integrations/source/gitlab.md @@ -131,13 +131,4 @@ they're activated automatically with a copy of the parent's data However, environments based on (non-merge-request) **branches** can't have parents; they inherit directly from your default branch and start inactive by default. -## Clones and commits - -You can clone your codebase by running `platform get ` -or in your project in the console by going to Code > Git and running the `git clone` command. - -When you perform this action, you are actually cloning from your remote integrated repository, -so long as you have the [appropriate access to do so](/administration/users.md#user-access-and-integrations). - -Your GitLab repository is considered by Platform.sh to be the "source of truth" for the project. -The project is only a mirror of that repository, and all commits should be pushed only to GitLab. +{{% clone-commit name="GitLab" %}} diff --git a/docs/src/languages/dotnet.md b/docs/src/languages/dotnet.md index baf7df394e..68c820bf30 100644 --- a/docs/src/languages/dotnet.md +++ b/docs/src/languages/dotnet.md @@ -18,7 +18,8 @@ description: | ## Building the application -For simple applications, using the [`dotnet publish`](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-publish?tabs=netcore21) default [framework-dependent deployment](https://docs.microsoft.com/en-us/dotnet/core/deploying/#framework-dependent-deployments-fdd) method is sufficient for building applications in .NET containers: +To build basic applications in .NET containers, it's enough to use the [`dotnet publish` command](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-publish) +with the default [framework-dependent deployment](https://docs.microsoft.com/en-us/dotnet/core/deploying/#publish-framework-dependent): ```yaml hooks: @@ -43,7 +44,9 @@ Incoming requests are passed to the application using either a TCP (default) or There will be an Nginx server sitting in front of your application. Serving static content via Nginx is recommended, as this allows easy control of headers (including cache headers) and also has marginal performance benefits. -Note that HTTPS is also terminated at the Ngnix proxy, so the `app.UseHttpsRedirection();` line in `Startup.cs` should be removed. To force HTTPS-only, please refer to the [routes documentation](/configuration/routes/https.md#https). +Note that HTTPS is also terminated at the Nginx proxy, +so the `app.UseHttpsRedirection();` line in `Startup.cs` should be removed. +To force HTTPS-only, refer to the [routes documentation](../configuration/routes/https.md#using-https). The following example configures an environment to serve the static content folders commonly found in [ASP.NET MVC](https://dotnet.microsoft.com/apps/aspnet/mvc) templates using Nginx, while routing other traffic to the .NET application. diff --git a/docs/src/languages/java/frameworks.md b/docs/src/languages/java/frameworks.md index c098806909..138cb083aa 100644 --- a/docs/src/languages/java/frameworks.md +++ b/docs/src/languages/java/frameworks.md @@ -89,7 +89,10 @@ The [Spring Framework](https://spring.io/projects/spring-framework) provides a c Apache Tomcat is an open-source implementation of the Java Servlet, JavaServer Pages, Java Expression Language and WebSocket technologies. {{< note >}} -By default, Spring Boot provides an embedded Apache Tomcat build. Therefore, if you want to use Tomcat with Spring, check the [Spring section](#Spring). + +By default, Spring Boot provides an embedded Apache Tomcat build. +Therefore, if you want to use Tomcat with Spring, check the [Spring section](#spring). + {{< /note >}} ### Templates diff --git a/docs/src/languages/java/tuning.md b/docs/src/languages/java/tuning.md index 6e8a6ef3a2..b2e1bc00ba 100644 --- a/docs/src/languages/java/tuning.md +++ b/docs/src/languages/java/tuning.md @@ -84,7 +84,5 @@ java -jar -Xmx$(jq .info.limits.memory /run/config.json)m -XX:+UseG1GC -XX:+UseS ## References -* [Java Memory Commands](https://community.platform.sh/t/java-memory-commands/481) * [How to Migrate my Java application to Platform.sh](https://community.platform.sh/t/how-to-migrate-my-java-application-to-platfrom-sh/529) -* [Garbage Collector Log](https://community.platform.sh/t/garbage-collector-log/482) * [Introduction to Garbage Collection Tuning](https://docs.oracle.com/en/java/javase/14/gctuning/introduction-garbage-collection-tuning.html#GUID-326EB4CF-8C8C-4267-8355-21AB04F0D304) diff --git a/docs/src/languages/php/frameworks.md b/docs/src/languages/php/frameworks.md index acd6a8984d..7170bbf3bc 100644 --- a/docs/src/languages/php/frameworks.md +++ b/docs/src/languages/php/frameworks.md @@ -8,7 +8,10 @@ so you can handle dependencies and builds for PHP frameworks by committing `comp ## Drupal -[Drupal](https://www.drupal.org/) is an open-source content management framework written in PHP. Since Composer comes pre-installed on Platform.sh, Drupal can be installed and updated completely using Composer. The default [build flavor](/overview/build-deploy.md#building-the-application) for PHP application runs `composer install` during build, handling all of your dependencies automatically. +[Drupal](https://www.drupal.org/) is an open-source content management framework written in PHP. +Since Composer comes pre-installed on Platform.sh, Drupal can be installed and updated completely using Composer. +The default [build flavor](../../configuration/app/app-reference.md#build) for PHP application +runs `composer install` during build, handling all of your dependencies automatically. * [Drupal 8/9 Guide](../../guides/drupal9/_index.md) @@ -16,7 +19,7 @@ so you can handle dependencies and builds for PHP frameworks by committing `comp Drupal FAQs, how-to guides and other tutorials right on [Platform.sh Community](https://community.platform.sh/). -* [Drupal on Platform.sh Community](https://community.platform.sh/search?q=drupal&expanded=true) +* [Drupal on Platform.sh Community](https://community.platform.sh/search?q=drupal) ### Templates @@ -71,7 +74,7 @@ Template projects (repositories in the [platformsh-templates](https://github.com All your WordPress FAQs, plus how-to guides and tutorials right on [Platform.sh Community](https://community.platform.sh/). -* [WordPress on Platform.sh Community](https://community.platform.sh/search?expanded=true&q=wordpress) +* [WordPress on Platform.sh Community](https://community.platform.sh/search?q=wordpress) ### Templates diff --git a/docs/src/other/changelog.md b/docs/src/other/changelog.md index 02f8763048..607d12adee 100644 --- a/docs/src/other/changelog.md +++ b/docs/src/other/changelog.md @@ -47,7 +47,7 @@ description: | ## 2020 * **December 2020** - * `us-4` region: We have [added](/development/public-ips.md#west-4-us-4platformsh-data-location-guarantee) another US region, `us-4`. + * `us-4` region: We have [added](../development/public-ips.md) another US region, `us-4`. --- * **September 2020** * Go 1.15: We now support [Go 1.15](/languages/go.md). @@ -57,7 +57,7 @@ description: | --- * **April 2020** * We now offer [Xdebug on PHP](/languages/php/xdebug.md) containers. - * Custom [activity scripts](/integrations/activity/_index.md#activity-scripts) are now available, in alpha. + * Custom [activity scripts](../integrations/activity/_index.md) are now available, in alpha. --- * **March 2020** * Go 1.14: We now support [Go 1.14](/languages/go.md). @@ -310,7 +310,7 @@ description: | * **April 2016** * White label capabilities (Magento Enterprise Cloud Edition): Support for Platform.sh white label offering. - First launch at [Magento Imagine 2016](http://imagine.magento.com/) in Las Vegas of [Magento Enterprise Cloud Edition](https://magento.com/products/enterprise-cloud-edition). + First launch at Magento Imagine 2016 in Las Vegas of Magento Enterprise Cloud Edition. --- * **March 2016** diff --git a/docs/src/security/pci.md b/docs/src/security/pci.md index 37363fed3a..2bb458899b 100644 --- a/docs/src/security/pci.md +++ b/docs/src/security/pci.md @@ -6,7 +6,7 @@ description: | Platform.sh is PCI DSS certified. --- -Refer to our [Compliance Guidance](https://docs.platform.sh/security/compliance-guidance.html) +Refer to our [Compliance Guidance](./compliance-guidance.md) for an overview of our compliance program, including security & compensating controls, and a general allocation of responsibility. ## Overview @@ -28,7 +28,7 @@ Please use a third-party processor. ## Responsibility Customers who want to run PCI workloads on Platform.sh must agree to and implement -the measures contained in the [Platform.sh PCI Responsibility Matrix](https://docs.google.com/spreadsheets/d/1zLkHpdUoX1VNC3wTipl3g-Z4eHjou-57IrQxE8GH6oA/edit#gid=238986323) (Excel). +the measures contained in the [Platform.sh PCI Responsibility Matrix](https://docs.google.com/spreadsheets/d/1zLkHpdUoX1VNC3wTipl3g-Z4eHjou-57IrQxE8GH6oA/edit) (Excel). This document provides guidance on shared responsibilities to achieve PCI DSS compliance using PCI DSS 3.2 as a reference. While Platform.sh provides a secure and PCI compliant infrastructure, diff --git a/docs/src/tutorials/third-party.md b/docs/src/tutorials/third-party.md index ad4f3140cb..22f08daa8d 100644 --- a/docs/src/tutorials/third-party.md +++ b/docs/src/tutorials/third-party.md @@ -104,7 +104,6 @@ Framework | Credit ## Tools & development -* **MySQL disk space** monitor https://github.com/galister/platformsh_mysqlmon * Create [**deploy commands you can run from composer**](https://github.com/dnunez24/platformsh-deploy-php), using Symfony * A small tool from Hanoii https://github.com/hanoii/drocal * Script to **sync a Drupal site** from Production to Local https://github.com/pjcdawkins/platformsh-sync diff --git a/styles/Vocab/Platform/accept.txt b/styles/Vocab/Platform/accept.txt index 17bd6a6fc7..637bbb5d86 100644 --- a/styles/Vocab/Platform/accept.txt +++ b/styles/Vocab/Platform/accept.txt @@ -76,6 +76,7 @@ scp shard shortcode Stempel +Strapi Symfony transclusion unencrypted