I agree that this is an important detail to keep consistent. It's further
complicated because things change between release versions, and the book
usually only speaks to the current master version.
I don't know how the tools work, but I believe that we generate portions of
the book from the site-defaults.xml. Perhaps we can extend this feature to
generate other portions of the book? Look at how the
file src/main/xslt/configuration_to_asciidoc_chapter.xsl is used as a
transformer, configured in the root pom.xml. Can we add additional xslt
files that populate specific nodes in/throughput the book text?
-n
On Fri, Mar 17, 2023 at 5:20 AM 张铎(Duo Zhang) wrote:
> Hi everyone,
>
> I have been working on removing the ‘hbase.regionserver.hlog.writer.impl’
> and ‘hbase.regionserver.hlog.reader.impl’ properties from our code base. In
> the process, I noticed that we have two places where we mention the default
> configuration values: one is hbase-default.xml in the hbase-common module,
> and the other is hbase-default.adoc in our asciidoc.
>
> However, these two files are not consistent with each other. I'm not sure
> if they are aligned in the past but at least right now, they are not
> aligned.
>
> This inconsistency can cause confusion for our users and developers.
> Therefore, I suggest that we either find a way to align these two files
> automatically (e.g., by generating hbase-default.adoc from
> hbase-defauilt.xml), or remove hbase-default.adoc altogether and refer
> users to hbase-default.xml for the default configuration values.
>
> What do you think? Please share your opinions and suggestions.
>
> Thanks. Regards
>
