Merge branch 'main' into multiplebackup-info

.github/ISSUE_TEMPLATE/new-content-form.yaml

@@ -2,9 +2,7 @@ name: Suggest a new page or section
 description: Suggest new content for the documentation
 title: "Doc: "
 labels: ["documentation"]
-assignees:
-  - cnivolle
-  - juliamrch
+projects: "CleverCloud/10"
 body:
   - type: markdown
     attributes:

.github/pull_request_template.md

@@ -10,5 +10,5 @@ _Summarize your changes here : explain what, how, and why. Be as explicict as yo
 
 
 ## Reviewers
-_Who should review these changes?_ @
+_Who should review these changes?_ @CleverCloud/reviewers
 

.github/styles/Google/Acronyms.yml

@@ -18,6 +18,7 @@ exceptions:
   - CSV
   - CORS
   - DEBUG
+  - DNS
   - DOM
   - DPI
   - EOL
@@ -36,6 +37,7 @@ exceptions:
   - JSON
   - JSX
   - LESS
+  - LLM
   - LLDB
   - NET
   - NOTE
@@ -64,6 +66,7 @@ exceptions:
   - URL
   - USB
   - UTF
+  - WAF
   - XML
   - XSS
   - YAML

.github/styles/config/vocabularies/Doc/accept.txt

@@ -15,6 +15,7 @@ checkMe
 Clever Cloud
 CLI
 Cloud
+Coraza
 cron
 Cyberduck
 Dockerfile
@@ -36,6 +37,7 @@ jarName
 Jboss
 Keycloak
 Laravel
+Let's Encrypt
 maven
 Matomo
 Metabase
@@ -48,6 +50,7 @@ nmap
 npm
 Nuxt
 OAuth
+Otoroshi
 Payara
 Percona
 Pgpool

.github/workflows/external-doc-update.yml.nope → .github/workflows/external-doc-update.yml

@@ -48,18 +48,18 @@ jobs:
           search_existing: all
 
       # Post a single comment with auto-updating body
-      - name: Create or update a comment
-        env:
-          CHANGED_FILES: ${{ steps.changed-files-specific.outputs.all_changed_files }}
-        uses: taoliujun/action-unique-comment@v1
-        with:
-          uniqueIdentifier: ${{ github.workflow }}
-          body: |
-            You updated ${{ env.CHANGED_FILES }}. This content is also listed on external doc. Issue number ${{ steps.create-issue.outputs.number }} has been created and assigned to you 🫵👁️👄👁️
-
-            See it or modify it here: 
-              * ${{ steps.create-issue.outputs.url }}
-
-            _This unique comment uses the very cool [taoliujun/action-unique-comment](https://github.com/marketplace/actions/unique-comment). Thank you <3_
+      #- name: Create or update a comment
+      #  env:
+      #    CHANGED_FILES: ${{ steps.changed-files-specific.outputs.all_changed_files }}
+      #  uses: taoliujun/action-unique-comment@v1
+      #  with:
+      #    uniqueIdentifier: ${{ github.workflow }}
+      #    body: |
+      #      You updated ${{ env.CHANGED_FILES }}. This content is also listed on external doc. Issue number ${{ steps.create-issue.outputs.number }} has been created and assigned to you 🫵👁️👄👁️
+      #      
+      #      See it or modify it here: 
+      #        * ${{ steps.create-issue.outputs.url }}
+      #      
+      #      _This unique comment uses the very cool [taoliujun/action-unique-comment](https://github.com/marketplace/actions/unique-comment). Thank you <3_
 
 

.github/workflows/review-app.yml

@@ -23,18 +23,20 @@ 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 }}
           CLEVER_TOKEN: ${{ secrets.CLEVER_TOKEN }}
           ORGA_ID: ${{ secrets.ORGA_ID }}
           GH_CC_PRE_BUILD_HOOK: './clevercloud-deploy-script.sh'
           GH_CC_WEBROOT: '/public'
-          GH_HEXTRA_VERSION: 'v0.8.4'
+          GH_HEXTRA_VERSION: 'v0.9.0'
           GH_HUGO_ENV: 'production'
-          GH_HUGO_VERSION: '0.135.0'
+          GH_HUGO_VERSION: '0.140.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'

.gitignore

@@ -1,6 +1,5 @@
 .DS_Store
-.idea
-/public/*
+/public/developers/*
 /resources
 .clever.json
 .vale.ini

CONTRIBUTING.md

@@ -1,8 +1,7 @@
 
 # Contributing guidelines
 
-This document provides explicit standards expected in Clever Cloud documentation. Inspiration and research for this document comes from [Google's Developer Documentation Style Guide](https://developers.google.com/style/tone), and the incredible [Awesome Code Review](https://github.com/joho/awesome-code-review) project.
-
+This document provides explicit standards expected in Clever Cloud documentation. Inspiration and research for this document comes from the incredible [Awesome Code Review](https://github.com/joho/awesome-code-review) project. 
 ## Standards
 
 Those are general standards to fulfill for every modification in this repository.
@@ -21,6 +20,8 @@ Follow the established structure in this doc. If you wish to propose changes to
 
 Follow these guidelines while writing new content. The goal is to help you write in a **clear, precise, and unambiguous language**. They're not meant to be a burden, but to help you deliver the best content possible.
 
+Sources for quality content are currently being updated.
+
 #### 👍 Do
 
 - **Don't assume the user "knows better":** if you think something is obvious, it's not. Better over-explain than under-explain.

assets/css/custom.css

@@ -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+ */
 }
 
 /* -----------------------------------------------
@@ -234,9 +234,15 @@ html[class~="dark"] .content a:has(code){
 /* Display an arrow at the end of the linked variable */
 .content a:not(.code-block code) code::after {
   content: "\00a0↗";
-  color: tomato;
-  font-size: 1.1rem;
-
+    color: tomato;
+    font-size: 1rem;
+    bottom: -2px;
+    position: relative;
+    left: 4px;
+    width: 14px;
+    display: inline-block;
+    height: 14px;
+    line-height: 0.35em;
 }
 
 /* Display arrow for external links in the main menu.

clevercloud-deploy-script.sh

@@ -2,4 +2,5 @@ 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
+echo "AddType text/markdown;charset=UTF-8 .md" > public/.htaccess

content/_index.md

@@ -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"
@@ -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"
@@ -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"
@@ -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 >}}

content/api/_index.md

@@ -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 >}}

content/api/howto.md

@@ -55,11 +55,11 @@ You need to set a callback URL, this is the url your user will be redirected to
 
 #### **Get a request token**
 
-You have to make a `POST`request to get a [request token](/api/v2/#post-/oauth/request_token) to the API.
+You have to make a `POST`request to get a [request token](/developers/api/v2/#post-/oauth/request_token) to the API.
 
 #### **Get the authorization URL**
 
-Ask the API for the [authorization URL](/api/v2/#get-/oauth/authorize) and go to this URL with a browser. Log in with your account and it will send you to the callback URL.
+Ask the API for the [authorization URL](/developers/api/v2/#get-/oauth/authorize) and go to this URL with a browser. Log in with your account and it will send you to the callback URL.
 
 #### **Get the verifier token**
 
@@ -71,7 +71,7 @@ Where `<verifierToken>` is your token.
 
 #### **Get the access token**
 
-Make a `POST`  request to get the [access token](/api/v2/#post-/oauth/access_token) with your request token and the verifier.
+Make a `POST`  request to get the [access token](/developers/api/v2/#post-/oauth/access_token) with your request token and the verifier.
 You can use this access token to make OAuth1 signed requests.
 
 More information about [OAuth dance](https://oauth.net/core/1.0/#anchor9).
@@ -88,8 +88,8 @@ All the API endpoints are referenced in a swagger documentation. **The base URL
 
 {{< cards >}}
 
-  {{< 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="/developers/api/v2/" title="Base v2 Endpoints" subtitle="Our base API endpoints with users, organisations, applications, add-ons, etc." icon="endpoints" >}}
+  {{< card link="/developers/api/v4/" title="New v4 Endpoints" subtitle="More recent API endpoints with billing, deployments, load balancers, logs, etc." icon="new" >}}
 
 {{< /cards >}}
 
@@ -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

content/api/v4.md

@@ -9,7 +9,7 @@ keywords:
 - endpoint
 - v4
 ---
-Clever Cloud provides a public REST API used by its own services and customers, known as [`/v2`](/api/v2). 
+Clever Cloud provides a public REST API used by its own services and customers, known as [`/v2`](/developers/api/v2/). 
 As our platform evolves, we're progressively moving to `/v4` endpoints, adding functionalities, with a more modern approach: 
 ```
 https://api.clever-cloud.com/v4/
@@ -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

content/changelog/2023-11-10-healthcheck-for-java.md

@@ -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/) 📖

content/changelog/2023-11-29-api-update.md

@@ -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").

content/changelog/2023-12-18-java-21-default.md

@@ -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")

content/changelog/2023-12-18-php-8-default.md

@@ -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" )

content/changelog/2023-12-19-console-web-components-v12.md

@@ -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" >}}

content/changelog/2024-01-24-ruby-3.3.0.md

@@ -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 >}}

content/changelog/2024-02-02-images-update.md

@@ -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

content/changelog/2024-02-22-postgresql-pgvector-support.md

@@ -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.
 

content/changelog/2024-02-26-healthcheck-for-everyone.md

@@ -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/) 📖