vy commented on code in PR #2772:
URL: https://github.com/apache/logging-log4j2/pull/2772#discussion_r1693285423


##########
src/site/antora/modules/ROOT/nav.adoc:
##########
@@ -43,7 +43,9 @@
 ** xref:manual/systemproperties.adoc[]
 ** xref:manual/customconfig.adoc[]
 ** xref:manual/appenders.adoc[]
+*** xref:manual/appenders/file.adoc[]

Review Comment:
   Shouldn't we move `rolling-file.adoc` to `appenders` folder to comply with 
this foldering convention too?



##########
src/site/antora/modules/ROOT/pages/manual/appenders.adoc:
##########
@@ -134,44 +160,45 @@ The following configuration attributes are also evaluated 
at runtime, so can con
 |===
 | Component | Parameter | Event type | Evaluation context
 
-| <<HttpAppender,`HttpAppender`>>
+| <<HttpAppender,`Http` appender>>

Review Comment:
   In accordance with our following existing component naming convention
   ```
   Pattern Layout
   JSON Template Layout
   etc.
   ```
   could you rename these to
   ```
   HTTP Appender
   Kafka Appender
   etc.
   ```
   please?



##########
src/site/antora/modules/ROOT/pages/manual/appenders.adoc:
##########


Review Comment:
   1. Shouldn't the default of `bufferedIo` point to 
`log4j2.enableDirectEncoders`, just like `bufferSize`?
   2. `can contain escaped $${...} expressions` :arrow_right: Can you rename 
`expressions` to `property substitution expressions`, please?



##########
src/site/antora/modules/ROOT/pages/manual/appenders.adoc:
##########
@@ -182,168 +209,6 @@ See 
xref:manual/configuration.adoc#lazy-property-substitution[runtime property s
 Log4j bundles several predefined appenders to assist in several common 
deployment use cases.
 Following sections explain all these in detail.
 
-[id=AsyncAppender]
-=== [[asyncappender]] AsyncAppender

Review Comment:
   We remove several appenders from the collection and only provide access to 
them in `nav.adoc`. IMHO, this incoherent navigation style makes it difficult 
for users to locate the removed appenders. Can't we instead keep them in the 
list of collections, but provide a link instead? (This is what we have done in 
`layouts.adoc` for PL and JTL too.)



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to