[
https://issues.apache.org/jira/browse/HBASE-25862?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17342088#comment-17342088
]
Nick Dimiduk commented on HBASE-25862:
--------------------------------------
Hi [~impself]. The project policy is to have unrelated changes be separate Jira
issues with separate commits. The reason being that if some change causes
problems and must be reverted, it can be removed from the product without also
removing other unrelated improvements.
In this case, I would recommend two Jira issues. One might be "update
documentation for log4j2.xml", where you would update section headers and add a
comment saying something like "As of version X.Y.Z, HBase has upgraded to
Log4j2, and so the configuration file name and format has changed." You could
have a second Jira called something like "fix various formatting issues in the
book," where you take a pass over the whole document and fix up formatting
problems like this bulleted list you have identified.
These two would be nice contributions!
> Improve the Configuration File Descriptions accuracy
> ----------------------------------------------------
>
> Key: HBASE-25862
> URL: https://issues.apache.org/jira/browse/HBASE-25862
> Project: HBase
> Issue Type: Bug
> Components: documentation
> Affects Versions: 3.0.0-alpha-1
> Reporter: Che Xun
> Assignee: Che Xun
> Priority: Minor
> Fix For: 3.0.0-alpha-1
>
> Attachments: image-2021-05-07-23-12-11-934.png
>
>
> In Apache HBase ™ Reference Guide
> *Need to modify part1：*
> 7.Default Configuration ->7.4. log4j.properties
> *explanation：*
> we need to update to 7.4 log4j2.xml
> *Need to modify part2：*
> In the first paragraph of the chapter 8.1，the details list is not displayed
> correctly，as show below：
>
> *!image-2021-05-07-23-12-11-934.png!*
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
