docs: some doc improvements (#186)

Signed-off-by: Ramkumar Chinchani <[email protected]>
project-zot · Jan 22, 2025 · f6c4d0b · f6c4d0b
1 parent 7b3a1e7
commit f6c4d0b
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 8 deletions.
diff --git a/docs/admin-guide/admin-configuration.md b/docs/admin-guide/admin-configuration.md
@@ -274,26 +274,26 @@ who has been denied access.
 ### Rate limiting
 
 You can limit the rate of API calls from users by configuring the
-`Ratelimit` attribute in the configuration file, as shown in the
+`ratelimit` attribute in the configuration file, as shown in the
 following example:
 
 ``` json
 "http": {
     "address": "127.0.0.1",
     "port": "8080",
-    "Ratelimit": {
-        "Rate": 10,
-        "Methods": [
+    "ratelimit": {
+        "rate": 10,
+        "methods": [
             {
-                "Method": "GET",
-                "Rate": 5
+                "method": "GET",
+                "rate": 5
             }
         ]
     }
 }
 ```
 
-In this example, the `Rate` attribute directly under `Ratelimit` sets a
+In this example, the `rate` attribute directly under `ratelimit` sets a
 global rate limit of ten API calls per second. You can optionally
 override the global limit for specific API `Methods`. In this example,
 API `GET` calls are limited to five per second.

diff --git a/docs/general/whats-new.md b/docs/general/whats-new.md
@@ -4,7 +4,13 @@
 
 ### Compatibility with other image schema types
 
-A new configuration setting allows you to store images using the schema [Docker Manifest v2 Schema v2](https://distribution.github.io/distribution/spec/manifest-v2-2/). With this setting enabled, zot makes no modifications to the image's manifest or digest. Such modifications would otherwise break the image's signature and attestations.
+A [new configuration setting](../admin-guide/admin-configuration.md#compatibility-with-other-image-schema-types) allows you to store images using the schema [Docker Manifest v2 Schema v2](https://distribution.github.io/distribution/spec/manifest-v2-2/). With this setting enabled, zot makes no modifications to the image's manifest or digest. Such modifications would otherwise break the image's signature and attestations.
+
+### Bug fixes
+
+The following security issue has been fixed in this release.
+
+[<code>GHSA-c9p4-xwr9-rfhxi/CVE-2025-23208</code>](https://github.com/project-zot/zot/security/advisories/GHSA-c9p4-xwr9-rfhx)
 
 ## [v2.1.0](https://github.com/project-zot/zot/releases/tag/v2.1.0)