Remko Popma created LOG4J2-678:
----------------------------------
Summary: Minor issues with Log4j2 web site/documentation
Key: LOG4J2-678
URL: https://issues.apache.org/jira/browse/LOG4J2-678
Project: Log4j 2
Issue Type: Bug
Components: Documentation
Affects Versions: 2.0-rc2
Reporter: Remko Popma
Priority: Minor
Fix For: 2.0
Various minor issues found with the site/documentation during review for RC2
release:
*StyleGuide page*
* Says that block indentation should be +2 spaces, but we're using +4 spaces.
* Says to indent continuation lines with at least +4 spaces, we're using +8
spaces.
* Has several links to "Column limit:120)" with a closing bracket ')' but no
opening bracket.
*JMX page*
Description for starting JMX Client GUI is missing log4j-api-2.0.jar in
classpath. (last 2 command line examples at the bottom of the page)
*Extending Log4j Configuration*
Spelling mistake:
"Programattically Adding ..." -> Programatically
*Components side-nav*
Not all modules have all 6 Component Reports (should have Rat Report,
Checkstyle, JavaDocs, Source Xref, PMD, CPD)
* Commons Logging Bridge: missing PMD, CPD
* Log4j 1.2 API: missing CPD
* SLF4J Binding: missing CPD
* Log4j2 to SLF4J Adapter: missing PMD, CPD
* Tag Lib: missing PMD, CPD
* JMX GUI: missing CPD
* Web Applications: missing Checkstyle, JavaDocs, Source Xref, PMD, CPD
* Web Applications has unnecessary "JIRA Report" link
* NoSQL Support/About: text now says: "Need something about
CouchDB/MongoDB"...
* NoSQL Support: missing Checkstyle, JavaDocs, Source Xref, PMD, CPD
* NoSQL Support has unnecessary "JIRA Report" link
*Issue Tracking*
First link on that page is the one that users are most likely to click. This
link should be to the Log4J issue tracker, not to the Atlassian Jira product
page. Unfortunately it looks like this page is auto-generated by a Maven
plugin. We may want to replace this with a custom page.
--
This message was sent by Atlassian JIRA
(v6.2#6252)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
