From 786e30056b0697aacd416d65205f9d56c2736233 Mon Sep 17 00:00:00 2001
From: ieQu1 <99872536+ieQu1@users.noreply.github.com>
Date: Fri, 23 Feb 2024 11:55:23 +0100
Subject: [PATCH] docs(ds): Add labels to the i18n for the storage schema

---
 rel/i18n/emqx_ds_schema.hocon | 45 +++++++++++++++++++++++------------
 1 file changed, 30 insertions(+), 15 deletions(-)

diff --git a/rel/i18n/emqx_ds_schema.hocon b/rel/i18n/emqx_ds_schema.hocon
index d80c086e9..999c62f8e 100644
--- a/rel/i18n/emqx_ds_schema.hocon
+++ b/rel/i18n/emqx_ds_schema.hocon
@@ -1,35 +1,50 @@
 emqx_ds_schema {
 
+messages.label: "MQTT message storage"
 messages.desc:
-"""Configuration related to the durable storage of MQTT messages."""
+  """~
+  Configuration related to the durable storage of MQTT messages.~"""
 
+builtin.label: "Builtin backend"
 builtin.desc:
-"""Builtin session storage backend utilizing embedded RocksDB key-value store."""
+  """~
+  Builtin session storage backend utilizing embedded RocksDB key-value store.~"""
 
+builtin_data_dir.label: "Database location"
 builtin_data_dir.desc:
-"""File system directory where the database is located."""
+  """~
+  File system directory where the database is located.~"""
 
+builtin_n_shards.label: "Number of shards"
 builtin_n_shards.desc:
-"""The builtin durable storage partitions data into shards.
-This configuration parameter defines the number of shards.
-Please note that it takes effect only during the initialization of the durable storage database.
-Changing this configuration parameter after the database has been already created won't take any effect."""
+  """~
+  The builtin durable storage partitions data into shards.
+  This configuration parameter defines the number of shards.
+  Please note that it takes effect only during the initialization of the durable storage database.
+  Changing this configuration parameter after the database has been already created won't take any effect.~"""
 
+builtin_egress.label: "Egress configuration"
 builtin_egress.desc:
-"""Configuration related to the buffering of messages from the local node to the shard leader."""
+  """~
+  Configuration related to the buffering of messages from the local node to the shard leader.~"""
 
+builtin_layout.label: "Storage layout"
 builtin_layout.desc:
-"""Storage layout is a method of arranging messages from various topics and clients on disc.
-
-Depending on the type of workload and the topic structure, different types of strategies for storing the data can be employed to maximize efficency of the replay."""
+  """~
+  Storage layout is a method of arranging messages from various topics and clients on disc.
 
+  Depending on the type of workload and the topic structure, different types of strategies for storing the data can be employed to maximize efficency of the replay.~"""
 
+layout_wildcard_optimized.label: "Wildcard-optimized storage layout"
 layout_wildcard_optimized.desc:
-"""_Wildcard-optimized_ layout is designed to maximize the throughput of the wildcard subscriptions covering large numbers of topics."""
+  """~
+  _Wildcard-optimized_ layout is designed to maximize the throughput of the wildcard subscriptions covering large numbers of topics.~"""
 
+wildcard_optimized_epoch_bits.label: "Epoch size"
 wildcard_optimized_epoch_bits.desc:
-"""Wildcard-optimized layout partitions messages recorded at different times into "epochs".
-Each epoch can be consumed by the subscribers as a batch.
-Generally, larger epochs lead to higher throughput of subscribers, however currently they may increase latency."""
+  """~
+  Wildcard-optimized layout partitions messages recorded at different times into "epochs".
+  Each epoch can be consumed by the subscribers as a batch.
+  Generally, larger epochs lead to higher throughput of subscribers, however currently they may increase latency.~"""
 
 }