yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: remove root namespace 

The root namespace was set to 'cluster' which is not very
accurate since not all the root level configs are 'cluster'
configs
This commit is contained in:
Zaiming (Stone) Shi 2022-06-21 21:19:56 +02:00
parent 0e62f4e70d
commit 717d5869a1
2 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
apps/emqx_conf/src/emqx_conf.erl
View File

@ -196,7 +196,9 @@ schema_module() ->
-spec gen_doc(file:name_all(), module(), file:name_all(), string()) -> ok. -spec gen_doc(file:name_all(), module(), file:name_all(), string()) -> ok.
gen_doc(File, SchemaModule, I18nFile, Lang) -> gen_doc(File, SchemaModule, I18nFile, Lang) ->
Version = emqx_release:version(), Version = emqx_release:version(),
Title = "# " ++ emqx_release:description() ++ " " ++ Version ++ " Configuration", Title =
"# " ++ emqx_release:description() ++ " Configuration\n\n" ++
"<!--" ++ Version ++ "-->",
BodyFile = filename:join([rel, "emqx_conf.template.en.md"]), BodyFile = filename:join([rel, "emqx_conf.template.en.md"]),
{ok, Body} = file:read_file(BodyFile), {ok, Body} = file:read_file(BodyFile),
Opts = #{title => Title, body => Body, desc_file => I18nFile, lang => Lang}, Opts = #{title => Title, body => Body, desc_file => I18nFile, lang => Lang},

3
apps/emqx_conf/src/emqx_conf_schema.erl
View File

@ -64,7 +64,8 @@
emqx_slow_subs_schema emqx_slow_subs_schema
]). ]).
namespace() -> cluster. %% root config should not have a namespace
namespace() -> undefined.
roots() -> roots() ->
PtKey = ?EMQX_AUTHENTICATION_SCHEMA_MODULE_PT_KEY, PtKey = ?EMQX_AUTHENTICATION_SCHEMA_MODULE_PT_KEY,