Skip to content

Commit

Permalink
Merge pull request platformsh#3433 from platformsh/remove-sections
Browse files Browse the repository at this point in the history
Remove sections
  • Loading branch information
chadwcarlson authored Sep 13, 2023
2 parents 65a652b + 52bf1e2 commit 04b277b
Show file tree
Hide file tree
Showing 31 changed files with 191 additions and 23 deletions.
12 changes: 12 additions & 0 deletions sites/friday/config/_default/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,18 @@ module:
excludeFiles:
- "registry/*"
- "get-started/*"
- "development/transfer-dedicated.md"
- "administration/sso.md"
- "increase-observability/logs/forward-logs.md"
- "increase-observability/logs/forward-fastly-logs.md"
- "increase-observability/metrics/dedicated.md"
- "increase-observability/metrics/dedicated-generation-3.md"
- "domains/cdn/managed-fastly.md"
- "domains/security/web-application-firewall/fastly.md"
- "dedicated-gen-2/*"
- "dedicated-gen-3/*"
- "guides/*"
- "languages/java/frameworks.md"
- "learn/resources.md"
lang: "en"

Expand Down
4 changes: 0 additions & 4 deletions sites/friday/config/_default/params.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,6 @@ navSections:
title: Learn
section: learn
weight: -110
guides:
title: Frameworks
section: guides
weight: -100
home:
title: Reference
section: home
Expand Down
12 changes: 12 additions & 0 deletions sites/platform/src/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,25 @@ After going through the **Get started** section, you may want to know more about
Now that you understand the basic rules of {{< vendor/name >}}, you're likely ready to deploy your own custom code in a chosen framework.
The **Frameworks** section is a collection of framework-specific how-to guides - from best practices to configuration, local development, and more.

{{< version/specific >}}

| Language | Frameworks |
| :---------------- | :------ |
| [Python](/languages/python/_index.md) | [Django](/guides/django/_index.md) |
| [PHP](/languages/php/_index.md) | [Drupal](/guides/drupal9/_index.md)<br/>[Ibexa](/guides/ibexa/_index.md)<br/>[Laravel](/guides/laravel/_index.md)<br/>[Symfony](/guides/symfony/_index.md)<br/>[TYPO3](/guides/typo3/_index.md)<br/>[WordPress](/guides/wordpress/_index.md) |
| [Javascript/Node.js](/languages/nodejs/_index.md) | [Gatsby](/guides/gatsby/_index.md)<br/>[Next.js](/guides/nextjs/_index.md)<br/>[Strapi](/guides/strapi/_index.md) |
| [Java](/languages/java/_index.md) | [Hibernate](/guides/hibernate/_index.md)<br/>[Jakarta](/guides/jakarta/_index.md)<br/>[Micronaut](/guides/micronaut/_index.md)<br/>[Quarkus](/guides/quarkus/_index.md)<br/>[Spring](/guides/spring/_index.md) |

<--->

| Language | Frameworks |
| :---------------- | :------ |
| [Python](/languages/python/_index.md) | [Django](/get-started/django/_index.md)<br/>[Flask](/get-started/flask/_index.md) |
| [PHP](/languages/php/_index.md) | [Laravel](/get-started/laravel/_index.md) |
| [Javascript/Node.js](/languages/nodejs/_index.md) | [Express](/get-started/express/_index.md)<br/>[Next.js](/get-started/nextjs/_index.md)<br/>[Strapi](/get-started/strapi/_index.md) |

{{< /version/specific >}}

### Reference

The **Reference documentation** section is the largest and most comprehensive.
Expand Down
2 changes: 1 addition & 1 deletion sites/platform/src/add-services/elasticsearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ premium : true

See the [Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html) for more information.

{{% frameworks %}}
{{% frameworks version="1" %}}

- [Drupal](../guides/drupal9/elasticsearch.md)
- [Jakarta EE](../guides/jakarta/deploy.md#elasticsearch)
Expand Down
2 changes: 1 addition & 1 deletion sites/platform/src/add-services/memcached.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ See the [Memcached documentation](https://memcached.org) for more information.

Both Memcached and Redis can be used for application caching. As a general rule, Memcached is simpler and thus more widely supported while Redis is more robust. {{< vendor/name >}} recommends using Redis if possible but Memcached is fully supported if an application favors that cache service.

{{% frameworks %}}
{{% frameworks version="1" %}}

- [Drupal](../guides/drupal9/memcached.md)

Expand Down
2 changes: 1 addition & 1 deletion sites/platform/src/add-services/mongodb.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebarTitle: "MongoDB"
premium: true
---

{{% frameworks %}}
{{% frameworks version="1" %}}

- [Jakarta EE](../guides/jakarta/deploy.md#mongodb)
- [Micronaut](../guides/micronaut/mongodb.md)
Expand Down
2 changes: 1 addition & 1 deletion sites/platform/src/add-services/mysql/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Their infrastructure setup is nearly identical, though they differ in some featu
See the [MariaDB documentation](https://mariadb.org/learn/)
or [MySQL documentation](https://dev.mysql.com/doc/refman/en/) for more information.

{{% frameworks %}}
{{% frameworks version="1" %}}

- [Hibernate](../../guides/hibernate/deploy.md#mysql)
- [Jakarta EE](../../guides/jakarta/deploy.md#mysql)
Expand Down
2 changes: 1 addition & 1 deletion sites/platform/src/add-services/postgresql.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ PostgreSQL is a high-performance, standards-compliant relational SQL database.

See the [PostgreSQL documentation](https://www.postgresql.org/docs/9.6/index.html) for more information.

{{% frameworks %}}
{{% frameworks version="1" %}}

- [Hibernate](../guides/hibernate/deploy.md#mysql)
- [Jakarta EE](../guides/jakarta/deploy.md#mysql)
Expand Down
2 changes: 1 addition & 1 deletion sites/platform/src/add-services/rabbitmq.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ that supports multiple messaging protocols, such as the Advanced Message Queuing
It gives your apps a common platform to send and receive messages
and your messages a safe place to live until they're received.

{{% frameworks %}}
{{% frameworks version="1" %}}

- [Spring](../guides/spring/rabbitmq.md)

Expand Down
2 changes: 1 addition & 1 deletion sites/platform/src/add-services/redis.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ for high-performance data retrieval and key-value storage.
- [Ephemeral](#ephemeral-redis): to set up a non-persistent cache for your application
- [Persistent](#persistent-redis): to set up fast persistent storage for your application

{{% frameworks %}}
{{% frameworks version="1" %}}

- [Drupal](../guides/drupal9/redis.md)
- [Ibexa DXP](../guides/ibexa/deploy.md#cache-and-sessions)
Expand Down
2 changes: 1 addition & 1 deletion sites/platform/src/add-services/solr.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Apache Solr is a scalable and fault-tolerant search index.

Solr search with generic schemas provided, and a custom schema is also supported. See the [Solr documentation](https://lucene.apache.org/solr/6_3_0/index.html) for more information."

{{% frameworks %}}
{{% frameworks version="1" %}}

- [Drupal](../guides/drupal9/solr.md)
- [Ibexa DXP](../guides/ibexa/deploy.md#solr-specificity)
Expand Down
4 changes: 4 additions & 0 deletions sites/platform/src/administration/pricing/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,8 @@ with a MySQL service and a Redis service.
If you aren't sure whether a specific setup would fit into a plan,
don't hesitate to [contact support](https://console.platform.sh/-/users/~/tickets).

{{< version/only "1" >}}

## {{% names/dedicated-gen-3 %}}

For more resources along with triple redundancy on every element of the stack, use a {{% names/dedicated-gen-3 %}} plan.
Expand All @@ -115,6 +117,8 @@ Learn more about [{{% names/dedicated-gen-3 %}}](../../dedicated-gen-3/_index.md

To discuss how {{% names/dedicated-gen-3 %}} could work for you, [contact Sales](https://platform.sh/contact/).

{{< /version/only >}}

## Enterprise overages

**The following applies to all Enterprise and Elite subscriptions.**
Expand Down
9 changes: 8 additions & 1 deletion sites/platform/src/create-apps/app-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -762,20 +762,27 @@ crons:

### Cron job timing

{{< version/specific >}}
<!-- Version 1 -->
Minimum time between cron jobs being triggered:

| Plan | Time |
|-------------------- | --------- |
| Professional | 5 minutes |
| Elite or Enterprise | 1 minute |

<--->
<!-- Version 2 -->
The minimum time between cron jobs being triggered is 5 minutes.
{{< /version/specific >}}

For each app container, only one cron job can run at a time.
If a new job is triggered while another is running, the new job is paused until the other completes.

To minimize conflicts, a random offset is applied to all triggers.
The offset is a random number of seconds up to 20 minutes or the cron frequency, whichever is smaller.

Crons are also paused while activities such as [backups](../dedicated-gen-2/overview/backups.md) are running.
Crons are also paused while activities such as backups are running.
The crons are queued to run after the other activity finishes.

To run cron jobs in a timezone other than UTC, set the [timezone property](#top-level-properties).
Expand Down
12 changes: 11 additions & 1 deletion sites/platform/src/create-apps/runtime-operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,17 +79,27 @@ run the following command:

```bash
{{% vendor/cli %}} operation:list --project {{< variable "PROJECT_ID" >}} --environment {{< variable "ENVIRONMENT_NAME" >}}
````
```

## Runtime operation examples

### Build your app when using a static site generator

{{< version/specific >}}
During every {{< vendor/name >}} deployment, a standard [`build` step](/learn/overview/build-deploy.md#the-build) is run.
When you use a static site generator like [Gatsby](../guides/gatsby/_index.md)
or [Next.js](../guides/nextjs/_index.md) with [a headless backend](../guides/gatsby/headless/_index.md),
you need to run a second `build` step to get your app ready for production.

<--->

During every {{< vendor/name >}} deployment, a standard [`build` step](/learn/overview/build-deploy.md#the-build) is run.
When you use a static site generator like Gatsby
or Next.js with a headless backend
you need to run a second `build` step to get your app ready for production.

{{< /version/specific >}}

This is because, as its framework is being built,
your frontend needs to pull content-related data from your backend’s API
(to generate all the static HTML pages your site is to serve).
Expand Down
9 changes: 8 additions & 1 deletion sites/platform/src/development/variables/use-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -357,6 +357,8 @@ and at runtime.
| `PORT` | No | Yes | A `string` representing the port to which requests are sent if the [`web.upstream.socket_family` property](../../create-apps/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](../../create-apps/app-reference.md#upstream) is set to `unix`. |

{{< version/specific >}}
<!-- These two sections are Platform.sh-specific -->
### Variables on {{% names/dedicated-gen-2 %}} environments

[{{% names/dedicated-gen-2 %}} instances](../../dedicated-gen-2/overview/_index.md) also have the following variables available:
Expand All @@ -366,7 +368,7 @@ and at runtime.
| `PLATFORM_CLUSTER` | No | Yes | The cluster ID. In older {{% names/dedicated-gen-2 %}} instances, this is used to get the project ID. When several projects are linked, this provides the main project/cluster they're linked to, while `PLATFORM_PROJECT` offers the specific project ID. |
| `PLATFORM_MODE` | No | Yes | `enterprise` in all {{% names/dedicated-gen-2 %}} production and staging environments. Note that an Enterprise support plan doesn't always imply a {{% names/dedicated-gen-2 %}} environment, but a {{% names/dedicated-gen-2 %}} environment always implies an Enterprise support plan. |

{{< note >}}
{{< note version="1" >}}

The `PLATFORM_CLUSTER` environment variable isn't yet available on [{{% names/dedicated-gen-3 %}}](../../dedicated-gen-3/_index.md).
If your application depends on whether it's running on a {{% names/dedicated-gen-3 %}} host, use `PLATFORM_MODE`.
Expand All @@ -390,6 +392,11 @@ else
fi
```
<--->
<!-- Removed from version 2 -->
{{< /version/specific >}}
### `PLATFORM_APPLICATION`
The `PLATFORM_APPLICATION` variable is available both at build time and in the runtime environment.
Expand Down
12 changes: 12 additions & 0 deletions sites/platform/src/domains/cdn/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,20 @@ These edge servers behave like local caches to nearby users.
Bringing content closer to users helps enhance your site's perceived performance
and so can improve user engagement and retention.

{{< version/specific >}}
<!-- Version 1 -->
Fastly is the recommended CDN for {{< vendor/name >}} projects.
By default, Dedicated projects include a [Fastly CDN managed by {{< vendor/name >}}](./managed-fastly.md).
Self-service Grid plans don't include a CDN by default, but you can set up one at any time,
such as [Fastly](./fastly.md) or [Cloudflare](./cloudflare.md).

<--->
<!-- Version 2 -->
Fastly is the recommended CDN for {{< vendor/name >}} projects.
Self-service projects don't include a CDN by default, but you can set up one at any time,
such as [Fastly](./fastly.md) or [Cloudflare](./cloudflare.md).
{{< /version/specific >}}

## DNS records

To start routing client traffic through your CDN, [set up a custom domain](../steps/_index.md).
Expand Down Expand Up @@ -62,6 +71,7 @@ To disable it, change your cache configuration for the routes behind a CDN to th
enabled: false
```
{{< version/only "1" >}}
## Configure your CDN to support high SLA
{{< premium-features/tiered "Enterprise and Elite" >}}
Expand All @@ -75,6 +85,8 @@ If you want {{< vendor/name >}} to limit checks to one or more of the following
- Europe
- East Asia / Oceania
{{< /version/only >}}
## Prevent direct access to your server
When you use a CDN, you might want to prevent direct access to your {{< vendor/name >}} server for security purposes.
Expand Down
6 changes: 6 additions & 0 deletions sites/platform/src/domains/cdn/fastly.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,15 @@ You can [use a CDN](./_index.md) to deliver your site's content to users more qu
To set up a Fastly CDN with your own Fastly subscription,
follow the instructions on this page.

{{< version/specific >}}
<!-- Version 1 -->
If you are using a Fastly CDN provided by {{< vendor/name >}},
for example as part of a Dedicated project,
see guidance about [Fastly CDNs managed by {{< vendor/name >}}](./managed-fastly.md).
<--->
<!-- Version 2 -->

{{< /version/specific >}}

## Before you begin

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,17 @@ You need:

{{< /note >}}

{{< version/specific >}}

If you use a [Managed Fastly](../cdn/managed-fastly.md) CDN,
it needs to be configured to operate with custom non-production domains.
For more information, [contact Support](https://console.platform.sh/-/users/~/tickets/open).
For more information, [contact Support](https://console.platform.sh/-/users/~/tickets/open).

<--->

<!-- Version 2, managed Fastly not included for now -->
{{< /version/specific >}}

- A production environment with at least one custom domain already set up
- At least one non-production (staging or development) environment
- Optional: The [{{< vendor/name >}} CLI](../../administration/cli/_index.md) (v4.8.0+)
Expand Down
12 changes: 12 additions & 0 deletions sites/platform/src/environments/backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,11 @@ For information on how long backups are retained, see the [data retention policy

## Backup schedule

{{< version/specific >}}
Backups for Dedicated environments have a [specific frequency](../dedicated-gen-2/overview/backups.md).
<--->

{{< /version/specific >}}

On Grid environments, non-Production environments can have up to 2 [manual backups](#create-a-manual-backup).
The number of available backups for Production environments depends on your schedule.
Expand Down Expand Up @@ -102,7 +106,11 @@ To downgrade to the lower schedule, [contact support](/learn/overview/get-suppor

## Use automated backups

{{< version/specific >}}
For Dedicated environments, see more about [backups of Dedicated environments](../dedicated-gen-2/overview/backups.md).
<--->

{{< /version/specific >}}

For Grid environments, automated backups are taken for Production environments at least once every day.
The exact number of backups depends on your [backup schedule](#backup-schedule).
Expand All @@ -122,8 +130,12 @@ They may make restorations less reliable.
To avoid such issues, schedule [manual backups](#create-a-manual-backup) during non-peak hours,
when the short amount of downtime is least noticed.

{{< version/specific >}}
Automated backups are always live, including those taken on [{{% names/dedicated-gen-3 %}}](../dedicated-gen-3/_index.md)
and [{{% names/dedicated-gen-2 %}}](../dedicated-gen-2/overview/_index.md) environments.
<--->

{{< /version/specific >}}

You can create a manual live backup on a Grid project:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,21 @@ To do so, follow these steps:
5. Retrieve your Blackfire server ID and server token.
6. Follow [the instructions from the Blackfire documentation](https://blackfire.io/docs/integrations/paas/platformsh).

{{< version/specific >}}
<!-- Version 1, where managed Fastly is available -->
If you're using the [Managed Fastly CDN](../../domains/cdn/managed-fastly.md),
it's already configured to operate with Blackfire.
If you're using a different [Content Delivery Network (CDN)](../../domains/cdn/_index.md),
make sure you [configure it](https://blackfire.io/docs/integrations/proxies/index)
to let Blackfire profile the code running on your servers.

<--->
<!-- Version 2, where managed Fastly isn't available -->
If you're using a [Content Delivery Network (CDN)](../../domains/cdn/_index.md),
make sure you [configure it](https://blackfire.io/docs/integrations/proxies/index)
to let Blackfire profile the code running on your servers.
{{< /version/specific >}}

### On {{% names/dedicated-gen-2 %}} infrastructure

To install Blackfire on your {{% names/dedicated-gen-2 %}} environments:
Expand All @@ -72,12 +81,22 @@ To install Blackfire on your {{% names/dedicated-gen-2 %}} environments:
5. Retrieve your Blackfire server ID and server token.
6. Send those credentials to [Support](https://console.platform.sh/-/users/~/tickets/open) so they complete the installation.

{{< version/specific >}}
<!-- Version 1, where managed Fastly is available -->
If you're using the [Managed Fastly CDN](../../domains/cdn/managed-fastly.md),
it's already configured to operate with Blackfire.
If you're using a different [Content Delivery Network (CDN)](../../domains/cdn/_index.md),
make sure you [configure it](https://blackfire.io/docs/integrations/proxies/index)
to let Blackfire profile the code running on your servers.

<--->
<!-- Version 2, where managed Fastly isn't available -->
If you're using a [Content Delivery Network (CDN)](../../domains/cdn/_index.md),
make sure you [configure it](https://blackfire.io/docs/integrations/proxies/index)
to let Blackfire profile the code running on your servers.

{{< /version/specific >}}

### Automated integration

{{< partial "observability-suite/body.md" >}}
Expand Down
Loading

0 comments on commit 04b277b

Please sign in to comment.