logging-log4j-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Remko Popma (JIRA)" <j...@apache.org>
Subject [jira] [Comment Edited] (LOG4J2-879) Minor documentation issues with the 2.1 release
Date Sun, 18 Oct 2015 16:51:05 GMT

    [ https://issues.apache.org/jira/browse/LOG4J2-879?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14179590#comment-14179590
] 

Remko Popma edited comment on LOG4J2-879 at 10/18/15 4:50 PM:
--------------------------------------------------------------

Current status:

Minor issues with the site:

(/) (master) On the Appenders page, the docs for MemoryMappedFileAppender mention "New since
2.1-beta." Should just be 2.1... I missed that.
(/) (master) The Layouts page does not mention the new GELF layout.
(/) The left-hand navigation bar for Layouts does not have a link to JSONLayout
(/) Javadoc is in the Java 6 format (I thought we did something to make it use the nicer looking
Java 8 format?)
(/) The Configuration manual page is wider than normal and displays a horizontal scrollbar.
(/) I suspect this is because in the System Properties table the Default Value org.apache.logging.log4j.jul.ApiLoggerAdapter
cannot be wrapped over multiple lines.
(x) On the Build page, the comment in italics below the title has the same color as links,
but it is not a link. Bit confusing.
(x) (Personal taste perhaps): On the Runtime Dependencies page, the warnings against combining
log4j-slf4j-impl with log4j-to-slf4j have a very light color that makes them a bit hard to
read and does not stand out very much. I would prefer a color that contrasts more with the
white background. Red bold-face like on the webapp manual page would work for me.
(x) (Enhancement, not a problem): The convenience of creating custom log levels in Log4j2
should be mentioned in the About page and the Manual Introduction page as one of the advantages
of Log4j 2. (In log4j 1 users had to create a subclass.)

Minor issues with the Manual PDF:

(x) $\{Log4jReleaseVersion} is not replaced with the version number in the PDF
(x) API Formatting Parameters example and output run off the page.
(x) API Mixing Loggers with Formatter Loggers example runs off the page.
(x) Configuration Chainsaw... example for advertisers exceeds the page width.
(x) The Configuration page's table with System Properties exceeds the page width.
(x) Web Apps Servlet 2.5 Web Applications example web.xml runs off the page.
(x) Web Apps Async Requests all 3 examples for TestAsyncServlet run off the page.
(x) Date Lookup example runs off the page
(x) Appender JDBC ConnectionFactory example runs off the page
(x) Appender NoSql JSON result runs off the page
(x) CsvLogEventLayout result runs off the page
(x) JSON Layout runs off the page
(x) Extending Log4j - LoggerConfig example runs off the page
(x) Extending Log4j - ThresholdFilter example runs off the page
(x) Programmatic Configuration - CustomConfigurationFactory code runs off the page
(x) Programmatic Configuration - MyXMLConfiguration runs off hte page


was (Author: garydgregory):
Current status:

Minor issues with the site:

(/) (master) On the Appenders page, the docs for MemoryMappedFileAppender mention "New since
2.1-beta." Should just be 2.1... I missed that.
(/) (master) The Layouts page does not mention the new GELF layout.
(x) The left-hand navigation bar for Layouts does not have a link to JSONLayout
(x) Javadoc is in the Java 6 format (I thought we did something to make it use the nicer looking
Java 8 format?)
(x) The Configuration manual page is wider than normal and displays a horizontal scrollbar.
(x) I suspect this is because in the System Properties table the Default Value org.apache.logging.log4j.jul.ApiLoggerAdapter
cannot be wrapped over multiple lines.
(x) On the Build page, the comment in italics below the title has the same color as links,
but it is not a link. Bit confusing.
(x) (Personal taste perhaps): On the Runtime Dependencies page, the warnings against combining
log4j-slf4j-impl with log4j-to-slf4j have a very light color that makes them a bit hard to
read and does not stand out very much. I would prefer a color that contrasts more with the
white background. Red bold-face like on the webapp manual page would work for me.
(x) (Enhancement, not a problem): The convenience of creating custom log levels in Log4j2
should be mentioned in the About page and the Manual Introduction page as one of the advantages
of Log4j 2. (In log4j 1 users had to create a subclass.)

Minor issues with the Manual PDF:

(x) The Configuration page has a code example for advertisers that exceeds the page width.
(x) The Configuration page's table with System Properties exceeds the page width.



> Minor documentation issues with the 2.1 release
> -----------------------------------------------
>
>                 Key: LOG4J2-879
>                 URL: https://issues.apache.org/jira/browse/LOG4J2-879
>             Project: Log4j 2
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 2.1
>            Reporter: Remko Popma
>            Priority: Minor
>             Fix For: 2.5
>
>
> Minor issues with the site:
> * On the Appenders page, the docs for MemoryMappedFileAppender mention "New since 2.1-beta."
Should just be 2.1... I missed that.
> * The Layouts page does not mention the new GELF layout.
> * The left-hand navigation bar for Layouts does not have a link to JSONLayout
> * Javadoc is in the Java 6 format (I thought we did something to make it use the nicer
looking Java 8 format?)
> * The Configuration manual page is wider than normal and displays a horizontal scrollbar.
>   I suspect this is because in the System Properties table the Default Value org.apache.logging.log4j.jul.ApiLoggerAdapter
cannot be wrapped over multiple lines.
> * On the Build page, the comment in italics below the title has the same color as links,
but it is not a link. Bit confusing.
> * (Personal taste perhaps): On the Runtime Dependencies page, the warnings against combining
log4j-slf4j-impl with log4j-to-slf4j have a very light color that makes them a bit hard to
read and does not stand out very much. I would prefer a color that contrasts more with the
white background. Red bold-face like on the webapp manual page would work for me. :-)
> * (Enhancement, not a problem): The convenience of creating custom log levels in Log4j2
should be mentioned in the About page and the Manual Introduction page as one of the advantages
of Log4j 2. (In log4j 1 users had to create a subclass.)
> Minor issues with the Manual PDF:
> * The Configuration page has a code example for advertisers that exceeds the page width.
> * The Configuration page's table with System Properties exceeds the page width.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

---------------------------------------------------------------------
To unsubscribe, e-mail: log4j-dev-unsubscribe@logging.apache.org
For additional commands, e-mail: log4j-dev-help@logging.apache.org


Mime
View raw message