[jira] [Comment Edited] (LOG4J2-3573) Bring building documentation in line

["Volkan Yazici (Jira)" <ji...@apache.org>]

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

Volkan Yazici edited comment on LOG4J2-3573 at 8/18/22 12:46 PM:
-----------------------------------------------------------------

Thanks for bringing this to our attention, [~wlfbck]. There are plenty of room for improvement in the Log4j documentation. I have removed {{build.md}} from the website and manual, and linked {{BUILDING.md}} in {{{}README.md{}}}. Mind closing the ticket after confirming the fix, please?

({{{}TlsSyslogAppenderTest{}}} hiccups on Windows are sadly a known issue. Feel free to submit a fix them. You can try {{./mvnw -DskipTests package}} for skipping tests.)


was (Author: vy):
Thanks for bringing this to our attention, [~wlfbck]. There are plenty of room for improvement in the Log4j documentation. I have removed {{build.md}} from the website and manual, and linked {{BUILDING.md}} in {{README.md}}. Mind closing the ticket after confirming the fix, please?

({{TlsSyslogAppenderTest}} hiccups on Windows are sadly a known issue. Feel free to submit a fix them.)

> Bring building documentation in line
> ------------------------------------
>
>                 Key: LOG4J2-3573
>                 URL: https://issues.apache.org/jira/browse/LOG4J2-3573
>             Project: Log4j 2
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 2.18.0
>            Reporter: Wolff Bock von Wuelfingen
>            Assignee: Volkan Yazici
>            Priority: Minor
>             Fix For: 2.19.0
>
>
> While looking at how to build log4j, i noticed several discrepancies; I looked at the branch release-2.x on github and on [https://logging.apache.org/log4j/2.x/build.html]
> The website seems outdated, atleast the files it lists don't exist (anymore?). Luckily the instructions in BUILDING.md work. If it is possible to somehow just display the content of the BUILDING.md in that section of the website (or just link to it) it should simplify keeping the instructions up to date.
> I think it would be good if README.md under "Building From Source" simply referred to BUILDING.md, similar to the "Contributing" section. With both changes there is then only one document to update when building procedures change.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)