Skip to content

Commit

Permalink
🐛 Fix broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
CollierCZ committed Mar 1, 2022
1 parent 3700822 commit 0c8e5a8
Show file tree
Hide file tree
Showing 70 changed files with 181 additions and 149 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/check-links.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
10 changes: 10 additions & 0 deletions docs/layouts/shortcodes/clone-commit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Clones and commits

You can clone your codebase by running `platform get <projectID>`
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" }}.
5 changes: 3 additions & 2 deletions docs/layouts/shortcodes/gen-3-services.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@
<th>Supported versions</th>
</tr>
{{- 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" -}}
<tr>
<td><a href="/configuration/services/{{ $image }}.html">{{ $label }}</a></td>
<td><a href="{{ $docs_link }}">{{ $label }}</a></td>
<td>
{{- $service_versions := "" -}}
{{- range $versions -}}
Expand Down
7 changes: 6 additions & 1 deletion docs/layouts/shortcodes/guides/gatsby/headless-backend.html
Original file line number Diff line number Diff line change
@@ -1 +1,6 @@
<p>There has only been a single modification to Platform.sh&rsquo;s <a href="https://github.com/platformsh-templates/{{ anchorize ( .Get "name" ) }}" target="_blank" rel="noopener">standard {{ .Get "name" }} template</a> configuration in the multi-app template: the <code>name</code> attibribute in {{ .Get "name" }}&rsquo;s <code>.platform.app.yaml</code> has been updated to <code>{{ anchorize ( .Get "name" )}}</code>. You will notice this value used when the <code>relationship</code> between Gatsby and {{ .Get "name" }} is defined <a href="#gatsby">below for Gatsby</a> and in the <a href="#platformroutesyaml">routes</a> configuration above.</p>
{{ $name := .Get "name" }}
{{ $template := $name }}
{{ if eq $name "Drupal" }}
{{ $template = "Drupal9"}}
{{ end }}
<p>There has only been a single modification to Platform.sh&rsquo;s <a href="https://github.com/platformsh-templates/{{ anchorize ( $template ) }}" target="_blank" rel="noopener">standard {{ $name }} template</a> configuration in the multi-app template: the <code>name</code> attibribute in {{ $name }}&rsquo;s <code>.platform.app.yaml</code> has been updated to <code>{{ anchorize ( $name )}}</code>. You will notice this value used when the <code>relationship</code> between Gatsby and {{ $name }} is defined <a href="#gatsby">below for Gatsby</a> and in the <a href="#platformroutesyaml">routes</a> configuration above.</p>
2 changes: 1 addition & 1 deletion docs/layouts/shortcodes/guides/gatsby/headless-gatsby.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
</li>
<li>
<p><code>post_deploy</code></p>
<p>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 <a href="https://github.com/platformsh-templates/gatsby/blob/master/.platform.app.yaml#L21" target="_blank" rel="noopener"><code>gatsby build</code></a>. {{ .Get "name" }} will not be available until after the deploy hook, and so Gatsby&rsquo;s build is postponed until the <a href="/configuration/app/hooks.html#post-deploy-hook"><code>post_deploy</code></a> hook below.</p>
<p>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 <a href="https://github.com/platformsh-templates/gatsby/blob/master/.platform.app.yaml#L21" target="_blank" rel="noopener"><code>gatsby build</code></a>. {{ .Get "name" }} will not be available until after the deploy hook, and so Gatsby&rsquo;s build is postponed until the <a href="/configuration/app/hooks/hooks-comparison.html#post-deploy-hook"><code>post_deploy</code></a> hook below.</p>
</li>
<li>
<p><code>mounts</code></p>
Expand Down
4 changes: 2 additions & 2 deletions docs/layouts/shortcodes/guides/lando.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<p><a href="https://github.com/lando/lando" target="_blank" rel="noopener">Lando</a> is Platform.sh&rsquo;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 <a href="https://docs.lando.dev/config/platformsh.html" target="_blank" rel="noopener">Lando documentation</a> for installing and setting up Lando on your system.</p>
<p><a href="https://github.com/lando/lando" target="_blank" rel="noopener">Lando</a> is Platform.sh&rsquo;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 <a href="https://docs.lando.dev/platformsh/" target="_blank" rel="noopener">Lando documentation</a> for installing and setting up Lando on your system.</p>
<p>Templates come configured for use already with a base <a href="https://docs.lando.dev/config/lando.html" target="_blank" rel="noopener">Landofile</a> 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 <code>recipe</code> attribute.</p>

{{ $file := printf "static/files/fetch/lando/%s" (.Get "repo" ) }}
{{ highlight ( readFile $file ) "yaml" ""}}

<p>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.</p>

<p>You can replicate this file, or otherwise follow the directions in the <a href="https://docs.lando.dev/config/platformsh.html#getting-started" target="_blank" rel="noopener">Lando documentation for Platform.sh</a> to setup the repository locally. Once you have completed the configuration, you can then start to local environment by running:</p>
<p>You can replicate this file, or otherwise follow the directions in the <a href="https://docs.lando.dev/platformsh/getting-started.html" target="_blank" rel="noopener">Lando documentation for Platform.sh</a> to setup the repository locally. Once you have completed the configuration, you can then start to local environment by running:</p>
<div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">$ lando start
</code></pre></div>
2 changes: 1 addition & 1 deletion docs/layouts/shortcodes/language-specification.md
Original file line number Diff line number Diff line change
@@ -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):

<!-- vale off -->
<div class="highlight-location">.platform.app.yaml</div>
Expand Down
2 changes: 2 additions & 0 deletions docs/layouts/shortcodes/spring-common-props.md
Original file line number Diff line number Diff line change
@@ -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).
2 changes: 1 addition & 1 deletion docs/src/administration/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
9 changes: 4 additions & 5 deletions docs/src/administration/web/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/src/configuration/app/app-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |

Expand Down
2 changes: 1 addition & 1 deletion docs/src/configuration/app/hooks/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion docs/src/configuration/app/troubleshoot-disks.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
10 changes: 5 additions & 5 deletions docs/src/configuration/services/headless-chrome.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
}
```
Expand All @@ -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');
Expand All @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/src/configuration/services/mongodb.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/src/configuration/services/mysql/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/src/configuration/services/mysql/troubleshoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/src/configuration/services/network-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
10 changes: 6 additions & 4 deletions docs/src/configuration/services/vault.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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 ".<SERVICE_NAME>[0].password"
```

`<SERVICE_NAME>` is the name you [defined in your `.platform.app.yaml` file](#add-the-relationship).
`<SERVICE_NAME>` 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.

Expand All @@ -70,11 +72,11 @@ Assign it to a variable as follows:
VAULT_URL=$(echo $PLATFORM_RELATIONSHIPS | base64 --decode | jq -r ".<SERVICE_NAME>[0].host"):$(echo $PLATFORM_RELATIONSHIPS | base64 --decode | jq -r ".<SERVICE_NAME>[0].port")
```

`<SERVICE_NAME>` is the name you [defined in your `.platform.app.yaml` file](#add-the-relationship).
`<SERVICE_NAME>` 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:

Expand Down
Loading

0 comments on commit 0c8e5a8

Please sign in to comment.