diff --git a/CHANGELOG.md b/CHANGELOG.md index 36c73d69..4fd0ee00 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -16,6 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 (#415→#417). - conf: Update description of `agent` > `racksdb_version` to describe its new semantic. +- docs: Update configuration reference documentation. ## [4.0.0] - 2024-11-28 diff --git a/docs/modules/conf/examples/gateway.ini b/docs/modules/conf/examples/gateway.ini index 34bc41ff..13bb9c36 100644 --- a/docs/modules/conf/examples/gateway.ini +++ b/docs/modules/conf/examples/gateway.ini @@ -115,7 +115,12 @@ url= # Default value: 4.0.0 version=4.0.0 -# Version of RacksDB API +# Minimal supported version of RacksDB API +# +# CAUTION: You SHOULD NOT change this parameter unless you really know what +# you are doing. This parameter is more intented for Slurm-web developers +# rather than end users. Slurm-web is officially tested and validated with +# the default value only. # # Default value: 0.4.0 racksdb_version=0.4.0 diff --git a/docs/modules/conf/partials/conf-gateway.adoc b/docs/modules/conf/partials/conf-gateway.adoc index 108f08da..988bd815 100644 --- a/docs/modules/conf/partials/conf-gateway.adoc +++ b/docs/modules/conf/partials/conf-gateway.adoc @@ -249,7 +249,13 @@ _No default value_ |racksdb_version |str -|Version of RacksDB API +|Minimal supported version of RacksDB API + +CAUTION: You SHOULD NOT change this parameter unless you really know what +you are doing. This parameter is more intented for Slurm-web developers +rather than end users. Slurm-web is officially tested and validated with +the default value only. + diff --git a/docs/utils/conf-ex.ini.j2 b/docs/utils/conf-ex.ini.j2 index 155a79e9..799a261a 100644 --- a/docs/utils/conf-ex.ini.j2 +++ b/docs/utils/conf-ex.ini.j2 @@ -58,8 +58,6 @@ {%- endif %} {%- if parameter._type == "bool" %} {%- set value = "yes" if value == True else "no" %} -{%- elif parameter._type == "uri" %} -{%- set value = value.geturl() %} {%- endif %} {%- if value.__class__.__name__ == 'list' %} {%- set value = "\n " + value | join('\n ') %}