reworked readme and schema

christianhuth · Jan 30, 2025 · 5d5a5ff · 5d5a5ff
1 parent 701f8aa
commit 5d5a5ff
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/charts/shlink-backend/README.md b/charts/shlink-backend/README.md
@@ -96,7 +96,7 @@ The command removes all the Kubernetes components associated with the chart and
 | config.trackingVisits.disableTrackingParam | string | `""` | The name of a query param that can be used to visit short URLs avoiding the visit to be tracked. This feature won’t be available if no value is provided. See [Tracking visits](https://shlink.io/documentation/tracking-visits/) for more info. |
 | config.trackingVisits.disableUaTracking | bool | `false` | Tells if tracking of the user agent should be disabled. See [Tracking visits](https://shlink.io/documentation/tracking-visits/) for more info. |
 | config.trackingVisits.trackOrphanVisits | bool | `true` | Tells if orphan visits should be tracked or not. See [Tracking visits](https://shlink.io/documentation/tracking-visits/) for more info. |
-| config.urlShortening.autoResolveTitles | bool | `true` | Used to automatically resolve the short URL’s title based on the <title /> tag in the long URL |
+| config.urlShortening.autoResolveTitles | bool | `true` | Used to automatically resolve the short URL’s title based on the title-tag in the long URL |
 | config.urlShortening.defaultShortCodesLength | int | `5` | The length you want generated short codes to have. It defaults to 5 and has to be at least 4, so any value smaller than that will fall back to 4. |
 | config.urlShortening.deleteShortUrlThreshold | string | `""` | The amount of visits on short URLs which will not allow them to be deleted. If not provided, this restriction will be disabled. |
 | config.urlShortening.multiSegmentSlugsEnabled | bool | `false` | Allows to create and handle multi-segment custom slugs when true is provided. See [multi-segment custom slugs](https://shlink.io/documentation/some-features/#multi-segment-custom-slugs) for more information. |

diff --git a/charts/shlink-backend/values.schema.json b/charts/shlink-backend/values.schema.json
@@ -508,7 +508,7 @@
           "properties": {
             "autoResolveTitles": {
               "default": true,
-              "description": "Used to automatically resolve the short URL’s title based on the \u003ctitle /\u003e tag in the long URL",
+              "description": "Used to automatically resolve the short URL’s title based on the title-tag in the long URL",
               "required": [],
               "title": "autoResolveTitles",
               "type": "boolean"

diff --git a/charts/shlink-backend/values.yaml b/charts/shlink-backend/values.yaml
@@ -208,7 +208,7 @@ config:
     # -- Tells if orphan visits should be tracked or not. See [Tracking visits](https://shlink.io/documentation/tracking-visits/) for more info.
     trackOrphanVisits: true
   urlShortening:
-    # -- Used to automatically resolve the short URL’s title based on the <title /> tag in the long URL
+    # -- Used to automatically resolve the short URL’s title based on the title-tag in the long URL
     autoResolveTitles: true
     # -- The length you want generated short codes to have. It defaults to 5 and has to be at least 4, so any value smaller than that will fall back to 4.
     defaultShortCodesLength: 5