Skip to content

Commit

Permalink
chore: migrate from subdomain to www.clever-cloud.com/developers (#429)
Browse files Browse the repository at this point in the history
## Describe your PR
 
- [**PREVIEW**](https://documentation-pr-429.cleverapps.io/developers/) 
- [**PREVIEW**](https://stagingv6.cleverapps.io/developers) with cc
staging website
GitHub Action executes the workflow from the base branch, which won't be
changed for security reasons. Hence, preview links in the comments
aren't accurate, but the preview is accessible from
`previw-link`/`developers`.

## Main changes

Instead of hosting the static files in `/public`, they're hosted in
`/public/developers` to create a route that will allow us to perform
path routing from `www.clever-cloud.com`. Final domain for the doc
should become `www.clever-cloud.com/developers`. For this reason, it's
been opted in the following cases:

- When the shortcode was already in use
- When the path contained +3 levels (error prone)

### Considerations

Replacing markdown links by Hugo links: `[value](link]` => `[value]({{<
ref "file" >}})` gives more freedom to keep moving files and
restructured as needed in the future, but anchors the doc in Hugo. If we
want to change the stack in the future, we'll need to modify every link.

### Locations where the paths have been reworked/checked in `/content`:

- [x] **doc**
  - [x] `/doc/*`
  - [x]  `guides/*` 
- [x] **shortcodes** (`/layouts/shortcodes/content`)
  - [x] `/doc/*`
  - [x]  `guides/*` 
- [x] **specific languages**
(`/layouts/shortcodes/content/language-specific-deploy`)
    - [x] `/doc/*`
    - [x]  `guides/*` 
- [x] **guides**
  - [x] `/doc/**`
  - [x]  `guides/*` 
- [x]  **changelog**
  - [x] `/doc/*`
  - [x]  `guides/*` 

## Checklist

- [x] My PR is related to an opened issue : not indicated in the
project, but coming from internal request.
- [x] I've read the [contributing
guidelines](/CleverCloud/documentation/blob/main/CONTRIBUTING.md)

### Tasks **before** merge

- [x] Add to Ahrefs
- [x] Fix 404 after Ahrefs audit
- [x] Create prefix routing on prod app
- [x] Redirect `developers.clever-cloud.com` =>
`www.clever-cloud.com/developers`
- [x] Update GitHub action domain

### Tasks **after** merge

- [ ]  Delete `developers.clever-cloud.com` from prod app


## Reviewers
_Who should review these changes?_ @
  • Loading branch information
juliamrch authored Dec 17, 2024
1 parent 0fd1669 commit b6e8733
Show file tree
Hide file tree
Showing 118 changed files with 636 additions and 466 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/review-app.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
token: ${{ secrets.GITHUB_TOKEN }}
fetch-depth: 0
- name: Manage review app
uses: CleverCloud/[email protected].0
uses: CleverCloud/[email protected].1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CLEVER_SECRET: ${{ secrets.CLEVER_SECRET }}
Expand All @@ -34,7 +34,9 @@ jobs:
GH_HEXTRA_VERSION: 'v0.8.4'
GH_HUGO_ENV: 'production'
GH_HUGO_VERSION: '0.135.0'

with:
type: 'static-apache'
set-env: true
environment: 'review'
domain: '${{ github.event.pull_request.base.repo.name }}-PR-${{ github.event.number }}.cleverapps.io/developers'
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
.DS_Store
.idea
/public/*
/public/developers/*
/resources
.clever.json
.vale.ini
Expand Down
4 changes: 2 additions & 2 deletions assets/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
font-family: 'Plus Jakarta Sans';
font-style: normal;
font-weight: 700;
src: url('/fonts/plus-jakarta-sans-v8-latin-700.woff2') format('woff2'), /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */
url('/fonts/plus-jakarta-sans-v8-latin-700.ttf') format('truetype'); /* Chrome 4+, Firefox 3.5+, IE 9+, Safari 3.1+, iOS 4.2+, Android Browser 2.2+ */
src: url('/developers/fonts/plus-jakarta-sans-v8-latin-700.woff2') format('woff2'), /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */
url('/developers/fonts/plus-jakarta-sans-v8-latin-700.ttf') format('truetype'); /* Chrome 4+, Firefox 3.5+, IE 9+, Safari 3.1+, iOS 4.2+, Android Browser 2.2+ */
}

/* -----------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion clevercloud-deploy-script.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ wget https://github.com/gohugoio/hugo/releases/download/v$HUGO_VERSION/hugo_exte
tar xvf hugo_extended_"$HUGO_VERSION"_Linux-64bit.tar.gz
chmod +x ./hugo
./hugo mod get github.com/imfing/hextra@$HEXTRA_VERSION
./hugo --gc --minify --destination public
./hugo --gc --minify --destination public/developers
12 changes: 6 additions & 6 deletions content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ width: normal
{{< hextra/feature-card
title="Environment Variables"
subtitle="Environment variables are a simple way of configuring your applications, their deployment and their behaviour."
link="/doc/reference/reference-environment-variables"
link="doc/reference/reference-environment-variables"
class="hx-aspect-auto md:hx-aspect-[1.1/1] max-md:hx-min-h-[340px]"
image="/images/icons.png"
imageClass="hx-top-[40%] hx-left-[24px] hx-w-[180%] sm:hx-w-[110%] dark:hx-opacity-80"
Expand All @@ -47,7 +47,7 @@ width: normal
{{< hextra/feature-card
title="API"
subtitle="The Clever Cloud API reference."
link="/api"
link="api"
class="hx-aspect-auto md:hx-aspect-[1.1/1] max-lg:hx-min-h-[340px]"
image="/images/metrics-home.png"
imageClass="hx-top-[40%] hx-left-[36px] hx-w-[180%] sm:hx-w-[110%] dark:hx-opacity-80"
Expand All @@ -56,7 +56,7 @@ width: normal
{{< hextra/feature-card
title="The CLI Clever Tools"
subtitle="An official Command Line Interface for Clever Cloud."
link="/doc/cli"
link="doc/cli"
class="hx-aspect-auto md:hx-aspect-[1.1/1] max-md:hx-min-h-[340px]"
image="/images/brand.png"
imageClass="hx-top-[40%] hx-left-[36px] hx-w-[110%] sm:hx-w-[110%] dark:hx-opacity-80"
Expand All @@ -65,18 +65,18 @@ width: normal
{{< hextra/feature-card
title="Steps by Steps Guides"
subtitle="Find detailed tutorials to deploy your favorite framework on Clever Cloud"
link="/guides"
link="guides"
>}}
{{< hextra/feature-card
title="Deploy an application"
subtitle="See supported languages and how to configure your app to deploy successfully"
link="/doc/applications"
link="doc/applications"
>}}
{{< hextra/feature-card
title="Connect your application to dependencies"
subtitle="See available add-ons such as MySQL, PostgreSQL, Redis, Mongo, Elastic..."
link="/doc/addons"
link="doc/addons"
>}}
{{< /hextra/feature-grid >}}
6 changes: 3 additions & 3 deletions content/api/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ aliases:
{{< /hextra/hero-subtitle >}}

{{< cards >}}
{{< card link="/api/howto" title="How to use our API" subtitle="Learn more about Clever Cloud API, endpoints, auth and how to access it from multiple tools." icon="api" >}}
{{< card link="/api/v2" title="Base v2 Endpoints" subtitle="Our base API endpoints with users, organisations, applications, add-ons, etc." icon="endpoints" >}}
{{< card link="/api/v4" title="New v4 Endpoints" subtitle="More recent API endpoints with billing, deployments, load balancers, logs, etc." icon="new" >}}
{{< card link="howto" title="How to use our API" subtitle="Learn more about Clever Cloud API, endpoints, auth and how to access it from multiple tools." icon="api" >}}
{{< card link="v2" title="Base v2 Endpoints" subtitle="Our base API endpoints with users, organisations, applications, add-ons, etc." icon="endpoints" >}}
{{< card link="v4" title="New v4 Endpoints" subtitle="More recent API endpoints with billing, deployments, load balancers, logs, etc." icon="new" >}}

{{< /cards >}}
2 changes: 1 addition & 1 deletion content/api/howto.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ You need to replace `<oauth_header>` by the signed OAuth1 header.

#### Logs

[This endpoint](https://www.clever-cloud.com/doc/api/#!/logs/logs_logs-socket_appId_get)
[This endpoint](https://www.clever-cloud.com/api/#!/logs/logs_logs-socket_appId_get)
allows you to receive real-time logs of an application via WebSocket.

#### Events
Expand Down
2 changes: 1 addition & 1 deletion content/api/v4.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ Example response, for each zone:
- `/v4/addon-providers/addon-pulsar/addons/{addon-id}/storage-policies`
- Type: `GET`/`PATCH`

Define or get offload/retention policies of a [Pulsar add-on](/doc/addons/pulsar/). Retention is how long messages are kept in the topic. Offload is how long messages are kept in the hot storage (NVMe SSD) before being moved to Cellar object storage (S3 compatible, HDD).
Define or get offload/retention policies of a [Pulsar add-on]({{< ref "/doc/addons/pulsar" >}}). Retention is how long messages are kept in the topic. Offload is how long messages are kept in the hot storage (NVMe SSD) before being moved to Cellar object storage (S3 compatible, HDD).

Example query/response:
```bash
Expand Down
2 changes: 1 addition & 1 deletion content/changelog/2023-11-10-healthcheck-for-java.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ You can now define the paths that the orchestrator will call to validate a deplo

Currently, the orchestrator only checks whether the application is listening to TCP port `8080`. It does not always mean that the application has started correctly.

- Read the documentation about [Deployment healthcheck path](https://developers.clever-cloud.com/doc/develop/healthcheck/) 📖
- Read the documentation about [Deployment healthcheck path](../../doc/develop/healthcheck/) 📖
2 changes: 1 addition & 1 deletion content/changelog/2023-11-29-api-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ For years, you can deploy applications on Clever Cloud as a `Task` with the API
}
```

You can read the full APIv2 documentation [here](http://developers.clever-cloud.com/openapi).
You can read the full APIv2 documentation [here]({{< ref "/api/v2" >}} "OpenAPI").
2 changes: 1 addition & 1 deletion content/changelog/2023-12-18-java-21-default.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ excludeSearch: true

Java version 21 is available on Clever Cloud for several weeks, but is now deployed as the default version for new applications. Of course, you can set the one of your choice between those available through `CC_JAVA_VERSION` environment variable.

- Read our documentation [about Java](doc/applications/java/)
- Read our documentation [about Java]({{< ref "/doc/applications/java" >}} "Java Doc")
2 changes: 1 addition & 1 deletion content/changelog/2023-12-18-php-8-default.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ excludeSearch: true

PHP 8.x is available for years on Clever Cloud, but is now deployed as the default version for new applications. Of course, you can set the one of your choice between those available through `CC_PHP_VERSION` environment variable.

- Read our documentation [about PHP version](doc/applications/php/#choose-your-php-version)
- Read our documentation [about PHP version]({{< ref "/doc/applications/php/#choose-your-php-version" >}} "Choose PHP version" )
2 changes: 1 addition & 1 deletion content/changelog/2023-12-19-console-web-components-v12.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ Among other changes under the hood, our [Console](https://console.clever-cloud.c

Links to the new documentation are now available in the Console. They're more precise depending on the `variant` (e.g. PHP/Static), use small icons to boost visibility and are now effective for applications and add-ons:

{{< figure src="/images/changelog/doc-link-console.webp" caption="The new documentation link in the Console" >}}
{{< figure src="/developers/images/changelog/doc-link-console.webp" caption="The new documentation link in the Console" >}}
4 changes: 2 additions & 2 deletions content/changelog/2024-01-24-ruby-3.3.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ description: Use Ruby 3.3.0 in your Ruby on Rails applications on Clever Cloud
excludeSearch: true
---

You can now choose the `3.3.0` release of Ruby when you deploy Ruby on Rails applications on Clever Cloud. It can be set either through your `Gemfile` or the `CC_RUBY_VERSION` [environment variable](https://developers.clever-cloud.com/doc/reference/reference-environment-variables/#ruby).
You can now choose the `3.3.0` release of Ruby when you deploy Ruby on Rails applications on Clever Cloud. It can be set either through your `Gemfile` or the `CC_RUBY_VERSION` [environment variable](../../doc/reference/reference-environment-variables/#ruby).

* Learn more about Ruby 3.3.0 release [here](https://www.ruby-lang.org/en/news/2023/12/25/ruby-3-3-0-released/)

{{< callout type="info" >}}
If you use Node.js on this image, be aware that default version is now 20.11.0 (LTS). If you need another release to deploy your application, set the `CC_NODE_VERSION` [environment variable](/doc/develop/env-variables/).
If you use Node.js on this image, be aware that default version is now 20.11.0 (LTS). If you need another release to deploy your application, set the `CC_NODE_VERSION` [environment variable](../../doc/develop/env-variables/).
{{< /callout >}}
2 changes: 1 addition & 1 deletion content/changelog/2024-02-02-images-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ excludeSearch: true

Over the past few months, we've overhauled the way we build our applications and add-ons images from tooling to included binaries. We'll deliver soon the first public milestone of this project, which will leads us to more frequent releases.

In the meantime, we've updated Docker, Erlang, Go, Haskell, Ruby and Rust images into production with no impact for our users. They include security patches and now use Linux kernel 6.7.1, OpenSSL 3.2.1 and Node.js 20.11.0 by default. For the latter, you can change it in the updated images via the `CC_NODE_VERSION` [environment variable](/doc/reference/reference-environment-variables/#commons-to-all-applications). Other changes are as follows:
In the meantime, we've updated Docker, Erlang, Go, Haskell, Ruby and Rust images into production with no impact for our users. They include security patches and now use Linux kernel 6.7.1, OpenSSL 3.2.1 and Node.js 20.11.0 by default. For the latter, you can change it in the updated images via the `CC_NODE_VERSION` [environment variable](../../doc/reference/reference-environment-variables/#commons-to-all-applications). Other changes are as follows:

- **Docker**:
- moby 25.0.2
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ description: Your wishes are our commands
excludeSearch: true
---

PostgreSQL databases managed by Clever Cloud come with [lots of extensions enabled by default](/doc/addons/postgresql/#default-extensions). There are also [some you can ask for](/doc/addons/postgresql/#on-demand-extensions), and we'll set them up, like `pg_cron`, `pgtap` or `timescaledb`.
PostgreSQL databases managed by Clever Cloud come with [lots of extensions enabled by default](../../doc/addons/postgresql/#default-extensions). There are also [some you can ask for](../../doc/addons/postgresql/#on-demand-extensions), and we'll set them up, like `pg_cron`, `pgtap` or `timescaledb`.

We recently noticed an increased interest from our clients in supporting the `pgvector` extension, needed for specific (AI) workloads. To answer these needs, we've packaged it and are now able to provide it on-demand.

Expand Down
2 changes: 1 addition & 1 deletion content/changelog/2024-02-26-healthcheck-for-everyone.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ You can now define the paths that the orchestrator will call to validate a deplo
* If the application responds on this specified path, and the response code is between `200` and `300`, the orchestrator considers that the deployment has been validated.
* If it responds with a code outside this interval, the application is considered to have failed its deployment.

- Read the documentation about [Deployment healthcheck path](https://developers.clever-cloud.com/doc/develop/healthcheck/) 📖
- Read the documentation about [Deployment healthcheck path](../../doc/develop/healthcheck/) 📖

2 changes: 1 addition & 1 deletion content/changelog/2024-02-26-mtl-iplb-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ excludeSearch: true

As we're upgrading our infrastructure and load balancers in Montreal, we've added new failover IPs in this region.

If you configure your domains through CNAME records, this update will be transparent. But if you use A records, switch to CNAME or update your [DNS configuration](https://developers.clever-cloud.com/doc/administrate/domain-names/). Old IPs will continue to work for a while, but we recommend you to update your DNS as soon as possible to avoid any service interruption.
If you configure your domains through CNAME records, this update will be transparent. But if you use A records, switch to CNAME or update your [DNS configuration](../../doc/administrate/domain-names/). Old IPs will continue to work for a while, but we recommend you to update your DNS as soon as possible to avoid any service interruption.

## Applications

Expand Down
8 changes: 4 additions & 4 deletions content/changelog/2024-02-27-images-update-part2.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ description: New .Net version, Java Elastic/APM agent update
excludeSearch: true
---

Earlier this month, we published [a first set of updates](/changelog/2024-02-02-images-update/) for Docker, Erlang, Go, Haskell, Ruby and Rust. Some days ago, we finished this work and all images are now up-to-date. This process occurred with no impact for our users. As mentioned in a previous post, this enables [the new `healthcheck` feature](/changelog/2024-02-26-healthcheck-for-everyone/) available for all applications.
Earlier this month, we published [a first set of updates](../2024-02-02-images-update/) for Docker, Erlang, Go, Haskell, Ruby and Rust. Some days ago, we finished this work and all images are now up-to-date. This process occurred with no impact for our users. As mentioned in a previous post, this enables [the new `healthcheck` feature](../2024-02-26-healthcheck-for-everyone/) available for all applications.

New images include security patches, Linux kernel 6.7.1, OpenSSL 3.2.1 and Node.js 20.11.0 by default. For the latter, you can set it via the `CC_NODE_VERSION` [environment variable](/doc/reference/reference-environment-variables/#commons-to-all-applications). Other changes are as follows:
New images include security patches, Linux kernel 6.7.1, OpenSSL 3.2.1 and Node.js 20.11.0 by default. For the latter, you can set it via the `CC_NODE_VERSION` [environment variable](../../doc/reference/reference-environment-variables/#commons-to-all-applications). Other changes are as follows:

* **.Net:**
* Version 8.0 support
* `CC_DOTNET_VERSION` [environment variable](/doc/reference/reference-environment-variables/#net) can be `6.0` or `8.0`
* `CC_DOTNET_VERSION` [environment variable](../../doc/reference/reference-environment-variables/#net) can be `6.0` or `8.0`
* **Java - Elastic / APM:**
* The agent has been updated to 1.47.1
* Java 21 support

New PHP image is next to come, with 8.3 version support, we're currently working on it. After that, we'll bring our new strategy to build images into production. We're currently testing it, and preparing enhancements for multiples runtimes. Your applications will automatically benefit from it when available. [Stay tuned](/changelog/index.xml).
New PHP image is next to come, with 8.3 version support, we're currently working on it. After that, we'll bring our new strategy to build images into production. We're currently testing it, and preparing enhancements for multiples runtimes. Your applications will automatically benefit from it when available. [Stay tuned](../index.xml).
2 changes: 1 addition & 1 deletion content/changelog/2024-03-07-web-components-v13.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ description: Console update with new icons for the documentation
excludeSearch: true
---

Clever Cloud's [Web Components](/doc/clever-components/) v13 are available, with bug fixes, refactoring, and new features. We introduced new possibilities to highlight form fields (larger labels, with color), paving the way for our new add-on/application creation process.
Clever Cloud's [Web Components](https://www.clever-cloud.com/doc/clever-components/?path=/docs/readme--docs) v13 are available, with bug fixes, refactoring, and new features. We introduced new possibilities to highlight form fields (larger labels, with color), paving the way for our new add-on/application creation process.

A standardized API is used for UI components that depend on a smart component. It includes a `state` property receiving state type: `loaded`, `loading`, `error` and data. Latest smart components no longer rely on `rxjs`, making them easier to maintain.

Expand Down
2 changes: 1 addition & 1 deletion content/changelog/2024-05-30-php-8.3-java-22.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@ We've updated some of our images and deployed them without any impact for our us
* Support for NewRelic with Java 22
* **PHP:**
* Composer 2.7.6
* Support for PHP 8.3 with [all supported extensions](/doc/applications/php/#available-extensions-and-modules)
* Support for PHP 8.3 with [all supported extensions](../../doc/applications/php/#available-extensions-and-modules)
* PHP info apps are available for PHP [8.0](https://php80info.cleverapps.io), [8.1](https://php81info.cleverapps.io), [8.2](https://php82info.cleverapps.io) and [8.3](https://php83info.cleverapps.io)
2 changes: 1 addition & 1 deletion content/changelog/2024-06-10-mongo-db-terraform.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ excludeSearch: true

If you can deploy on Clever Cloud through our [Console](https://console.clever-cloud.com), our CLI ([Clever Tools](https://github.com/CleverCloud/clever-tools)), or our [API](/api/), you can also use Terraform and compatible tools such as [OpenTofu](https://opentofu.org/). We maintain a provider that allows you to manage your resources as code, from applications to add-ons (object storage, databases, etc.).

We've recently added support for Python and [Materia KV](/doc/addons/materia-kv/). It's MongoDB's turn [to be available](https://registry.terraform.io/providers/CleverCloud/clevercloud/latest/docs/resources/mongodb). You can now create such an add-on, choose its plan, region and get the credentials to connect to it.
We've recently added support for Python and [Materia KV](../../doc/addons/materia-kv/). It's MongoDB's turn [to be available](https://registry.terraform.io/providers/CleverCloud/clevercloud/latest/docs/resources/mongodb). You can now create such an add-on, choose its plan, region and get the credentials to connect to it.

* Learn more about [our Terraform provider](https://registry.terraform.io/providers/CleverCloud/clevercloud/latest/docs)
Loading

0 comments on commit b6e8733

Please sign in to comment.