You are viewing a plain text version of this content. The canonical link for it is here.

Posted to notifications@logging.apache.org by "Wolff Bock von Wuelfingen (Jira)" <ji...@apache.org> on 2022/08/14 21:34:00 UTC

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

Wolff Bock von Wuelfingen created LOG4J2-3573:
-------------------------------------------------

             Summary: 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


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)