Changelog feature

README.md

@@ -77,7 +77,81 @@ This linter can be downloaded and run locally, or used via VSCode:
 - <https://github.com/DavidAnson/vscode-markdownlint> for VSCode
 - <https://github.com/DavidAnson/markdownlint-cli2> as a NPM package
 
-#### Linting Configuration
+#### Linting configuration
 
 **Ignored markdown files** are listed in the `.markdownlintignore`.  
-**Ignored specifications**, such as some HTML tag of webcopponents, are configured in the `.markdownlint.jsonc`
+**Ignored specifications**, such as some HTML tag of Web Components, are configured in the `.markdownlint.jsonc`
+
+## Adding changelog entries *(internal only)*
+
+For any significant change to the platform (updates, new features, etc.) a new entry is created in the "content/changelog" folder.
+
+Several entries can be made per day, it's not a problem.
+
+Each entry should provides clear, straightforward information on the essentials. If you find yourself writing an enormous amount of content, this may not be the right approach. However, you can always add a little charm to your changelog, but it's a tricky business, requiring careful, well-placed word choice.
+
+Whenever possible, the famous "Bugs fixes and improvements" should be avoided.
+
+### Filename convention for new entries
+
+The filename is not very important for the Hugo build and publication process, but it will serve as a slug for the URL. Ideally, it can start with the date in **ISO 8601** format and the title in Kebab case. This naming convention allow the files to be sorted easily in any editor.
+
+The format is a markdown file with a `.md` extention:
+
+```text
+yyyy-mm-dd-your-title.md
+```
+
+### Front matter configuration
+
+Hugo uses front matter to enrich posts with metadata. Front matter allows you to keep metadata attached to an instance of a content type—i.e., embedded inside a content file. We use the following Front matter variables:
+
+- [`title`](https://gohugo.io/methods/page/title/) (required)
+  - The title that will be displayed in the main heading. The value is a `<string>`.
+
+- [`date`](https://gohugo.io/methods/page/description/) (recommended)
+  - The date that will be displayed in the post. The value is a string in ISO 8601 like `yyyy-mm-dd`.
+
+- [`description`](https://gohugo.io/methods/page/description/) (recommended)
+  - The description that will be displayed in meta-description for SEO purposes. The value is a `<string>`.
+
+- [`tags`](https://gohugo.io/content-management/taxonomies/#default-taxonomies) (recommended)
+  - Tags are recommended for easy product identification. They are written in lowercase and, if possible, use the same spelling throughout the posts. The value is a `<string>`.
+
+- [`category`](https://gohugo.io/content-management/taxonomies/#default-taxonomies) (optional)
+  - The category is used here to add a "new" label on the changelog homepage when a specific entry is a new feature that should be highlighted visually. The value must be `new`, and nothing else.
+
+- [`authors`](https://gohugo.io/content-management/taxonomies/#default-taxonomies) (optional)
+  - Can be set to showcase the people behind the product. Authors are defined with a `name`, `link` for their Github or any other social network, and an `image` for the profile picture. The profile picture can be set with the Github avatar with a link like `https://github.com/BlackYoup.png` and a the parameter `?size=40` for reducing the image size (recommended for performance). The values are all of `<string>` type.
+
+- [`excludeSearch`](https://imfing.github.io/hextra/docs/guide/configuration/#search-index) (recommended)
+  - Indicates whether the changelog will be indexed in search. It can be activated for a post if deemed necessary. The values to be set are either `true` or `false`
+
+```yaml
+---
+title: Redis updated to v7.2.4
+date: 2024-01-11
+tags:
+  - redis
+authors:
+  - name: BlackYoup
+    link: https://github.com/BlackYoup
+    image: https://github.com/BlackYoup.png?size=40
+excludeSearch: true
+description: Redis has been updated to v7.2.4 mostly to prevent security issues.
+---
+```
+
+### Adding images and screenshots
+
+Adding an image can be useful for highlighting a change of interface, for example.
+You can achieve this by using a shortcode, which is a simple snippet inside the content files, calling a built-in or custom templates.
+The shortcode we are using here is `figure`, as show below. Then move your image in the `/images/changelog/your-image.jpg` folder of this project.
+
+The image size can be modified and adapted using the `width` and `height` parameters.
+
+Example :
+
+```go
+{{< figure src="/images/changelog/console-new-ip-par.png" caption="The new IP shown in the console" width="800px">}}
+```

assets/css/custom.css

@@ -144,15 +144,17 @@ This will be applied also to code (except in tables):
 selectors in css can't be grained to target Markdown syntax
 (for now) */
 .content p a:not(.code),
-.content li a:not(.code) {
+.content li a:not(.code),
+article a {
   text-decoration-line: underline;
   text-decoration-style: dotted;
   text-decoration-color: rgb(214, 207, 251);
   color: rgb(90, 66, 212);
 }
 
 html[class~="dark"] .content p a:not(.code),
-html[class~="dark"] .content li a:not(.code) {
+html[class~="dark"] .content li a:not(.code),
+html[class~="dark"] article a {
   color: rgb(0, 172, 230);
 }
 

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

@@ -0,0 +1,17 @@
+---
+title: Custom healthcheck path for Java
+date: 2023-11-10
+tags:
+  - java
+excludeSearch: true
+description: Define custom healthcheck variables for java
+---
+
+This allows you to define variables in `CC_HEALTH_CHECK_PATH` format which define the paths that the orchestrator will call to validate a deployment, for Java appliactions.
+
+* 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 another error code outside this interval, the application is considered to have failed its deployment.
+
+Currently, the orchestrator only checks whether the application is listening to TCP port 8080. This does not always mean that the application has started correctly.
+
+The documentation is here: [Deployment healthcheck path](https://developers.clever-cloud.com/doc/develop/healthcheck/).

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

@@ -0,0 +1,29 @@
+---
+title: API update for tasks VM
+date: 2023-11-29
+tags:
+  - api
+excludeSearch: true
+description: You can now check if an application is a task via the API
+---
+The API has been updated to return a "TASK" state in the `instance.lifetime` object on the path `https://api.clever-cloud.com/v2/self/applications/{appId}`.  
+It is now easier to know whether an instance is of type "TASK" or not.
+
+```json{filename="GET https://api.clever-cloud.com/v2/self/applications/<appId>",linenos=table,hl_lines=[10]}
+{
+  "id": "string",
+  "name": "string",
+  "description": "string",
+  "zone": "string",
+  "zoneId": "string",
+  "instance": {
+    …
+    "defaultEnv": {},
+    "lifetime": "REGULAR",    //Allowed: REGULAR┃MIGRATION┃TASK
+    "instanceAndVersion": "string"
+  },
+  …
+}
+```
+
+You can find the full API [documentation here](http://developers.clever-cloud.com/openapi/#get-/self/applications/-appId-).

content/changelog/2023-12-13-cellar-migration-tool-update.md

@@ -0,0 +1,18 @@
+---
+title: Cellar migration tool update
+date: 2023-12-13
+tags:
+  - cellar
+excludeSearch: true
+description: Cellar migration tool update to 2.1.0
+---
+
+This release v2.1.0 of the [Cellar migration tool](https://github.com/CleverCloud/cellar-migration/releases/tag/v2.1.0) adds support for keep-alive in S3 clients and fixes a panic when a network error occurs.
+
+## About the Cellar migration tool
+
+The Cellar migration tool is a Command Line Interface tool to migrate your object storage buckets on Clever Cloud. This tool currently supports AWS-S3 and Cellar (Clever Cloud own Object Storage service) but it should work with any service implementing the S3 API.
+
+This is an rsync like tool that will synchronize your buckets. You can start it in a loop and it will only synchronize objects that are different between the two buckets. It is best to run it on a machine with a high network bandwidth.
+
+ Check this [project Github](https://github.com/CleverCloud/cellar-migration) {{< icon "github" >}}

content/changelog/2023-12-15-sozu-update.md

@@ -0,0 +1,15 @@
+---
+title: Sozu update
+date: 2023-12-15
+tags:
+  - sozu
+excludeSearch: true
+description: Sozu updated to version 0.15.18 
+---
+
+This release v0.15.18 of Sozu has been issue for performance and various bugfixes:
+
+* Fix 502 following a 304 response with a body that does not respect RFCs
+* Fix of a panic when upgrading from HTTP to WS or from HTTPs to WSs
+* Fix encryption issues when reusing TLS sessions (bump rustls)
+* Added `--json` flag to all commands

content/changelog/2023-12-18-java-update.md

@@ -0,0 +1,13 @@
+---
+title: Updated default Java version
+date: 2023-12-18
+tags:
+  - java
+excludeSearch: true
+description: New IP for DNS in PAR region are shown in the Console
+---
+
+Java version 21 is available on Clever Cloud but it was not the default version. We have updated our deployment processes to make Java 21 the default version.  
+You can however force another version with the environment variable `CC_PHP_VERSION`.
+
+Read our [documentation for more information about PHP version](doc/applications/php/#choose-your-php-version).

content/changelog/2023-12-18-new-ip-console.md

@@ -0,0 +1,13 @@
+---
+title: New DNS entries for the PAR region
+date: 2023-12-18
+tags:
+  - console
+excludeSearch: true
+description: New IP for DNS in PAR region are shown in the Console
+---
+
+New IP for DNS in PAR region are shown in the Console.  
+The new IP has been aded to the console in the **Domain Names** section.
+
+{{< figure src="/images/changelog/console-new-ip-par.png" caption="The new IP shown in the console" width="800px">}}

content/changelog/2023-12-18-php-update.md

@@ -0,0 +1,13 @@
+---
+title: Updated default PHP version
+date: 2023-12-18
+tags:
+  - php
+excludeSearch: true
+description: PHP update for all applications.
+---
+
+PHP version 8 is available on Clever Cloud but it was not the default version. We have updated our deployment processes to make PHP 8 the default version.  
+You can however force another version with the environment variable `CC_PHP_VERSION`.
+
+Read our [documentation for more information about PHP version](doc/applications/php/#choose-your-php-version).

content/changelog/2023-12-19-clever-components-12.md

@@ -0,0 +1,18 @@
+---
+title: Clever Web Components updated to v12
+date: 2023-12-19
+tags:
+  - components
+categories:
+- new
+excludeSearch: true
+description: Clever Web Components updated to version 12 with new components for the future log UI.
+---
+
+The Clever Web Components has been updated to version 12. On the menu:
+
+* bug fixes
+* breaking changes
+* and new components that will make up the heart of the new logs UI.
+
+📖 Full changelog: <https://github.com/CleverCloud/clever-components/releases/tag/12.0.0>

content/changelog/2023-12-19-console-update.md

@@ -0,0 +1,17 @@
+---
+title: Console update with new icons
+date: 2023-12-19
+tags:
+  - console
+excludeSearch: true
+description: Console update with new icons for the documentation
+---
+
+Among other changes under the hood, in the side menu when consulting an app, the link to the documentation is now:
+
+* functional for all types of application
+* more precise depending on the type of application (e.g. PHP app vs. static app)
+* now accompanied by a small icon to boost visibility
+* also effective for add-ons
+
+{{< figure src="/images/changelog/doc-link-console.png" caption="The new documentation link in the console" >}}

content/changelog/2023-12-22-sozu-update.md

@@ -0,0 +1,10 @@
+---
+title: Sozu update
+date: 2023-12-22
+tags:
+  - sozu
+excludeSearch: true
+description: Sozu updated to feature it as a load-balancer for databases.
+---
+
+Sozu can now be used as a load-balancer for any king of managed services, like databases.

content/changelog/2024-01-02-pulsar-update.md

@@ -0,0 +1,10 @@
+---
+title: Pulsar update
+date: 2024-01-02
+tags:
+  - pulsar
+excludeSearch: true
+description: Pulsar version 3.2.0 is deployed
+---
+
+Version 3.2.0 is now deployed and used on our platform. Our aim is to improve the availability of topics, by avoiding conflicts between namesspaces and bundle unloading.

content/changelog/2024-01-10-documentation-changelog.md

@@ -0,0 +1,21 @@
+---
+title: Changelog added
+date: 2024-01-10
+tags:
+  - changelog
+  - new
+authors:
+  - name: Julia March
+    link: https://github.com/juliamrch
+    image: https://github.com/juliamrch.png?size=40
+  - name: David Legrand
+    link: https://github.com/davlgd
+    image: https://github.com/davlgd.png?size=40
+  - name: Clément Nivolle
+    link: https://github.com/cnivolle
+    image: https://github.com/cnivolle.png?size=40
+excludeSearch: true
+description: Pulsar version 3.2.0 is deployed
+---
+
+A new changelog has been added to the [Developer Center](/changelog). It will be regularly edited by the various Clever Cloud teams, to give to our users an overview of our new features, changes and deprecations made on the platform.

content/changelog/2024-01-11-redis-update.md

@@ -0,0 +1,30 @@
+---
+title: Redis updated to v7.2.4
+date: 2024-01-11
+tags:
+  - redis
+authors:
+  - name: sardemff7
+    link: https://github.com/sardemff7
+    image: https://github.com/sardemff7.png?size=40
+  - name: BlackYoup
+    link: https://github.com/BlackYoup
+    image: https://github.com/BlackYoup.png?size=40
+excludeSearch: true
+description: Pulsar version 3.2.0 is deployed
+author:
+  -
+---
+A new version of Redis™  (`7.2.4`) is now available for each new instancied Redis.
+
+## Security fixes
+
+* (CVE-2023-41056) In some cases, Redis may incorrectly handle resizing of memory
+* buffers which can result in incorrect accounting of buffer sizes and lead to
+* heap overflow and potential remote code execution.
+
+## Bug fixes
+
+* Fix crashes of cluster commands clusters with mixed versions of 7.0 and 7.2 (#12805, #12832)
+* Fix slot ownership not being properly handled when deleting a slot from a node (#12564)
+* Fix atomicity issues with the RedisModuleEvent_Key module API event (#12733)

content/changelog/_index.md

@@ -0,0 +1,12 @@
+---
+title: Changelog
+width: normal
+description: Additions and changes to the Clever Cloud platform.
+---
+
+Additions and changes to the Clever Cloud platform.  
+
+{{< hextra/hero-badge link="index.xml" style="margin:10px 0 0 0">}}
+  Feed
+  {{< icon name="rss" attributes="height=14" >}}
+{{< /hextra/hero-badge >}}