From 6f5ce0b3392b7e717fa7c14965266db8d5b7c514 Mon Sep 17 00:00:00 2001 From: Stephen Webb Date: Sat, 27 Apr 2024 11:42:39 +1000 Subject: [PATCH] Add links to Logging Services support, security and download pages (#372) --- src/site/markdown/0-community.md | 35 ++++++++++- src/site/markdown/4-build.md | 3 +- src/site/markdown/change-report-gh.md | 40 +++++-------- src/site/markdown/community/issue-tracking.md | 59 ------------------- src/site/markdown/community/mailing-lists.md | 38 ------------ 5 files changed, 47 insertions(+), 128 deletions(-) delete mode 100644 src/site/markdown/community/issue-tracking.md delete mode 100644 src/site/markdown/community/mailing-lists.md diff --git a/src/site/markdown/0-community.md b/src/site/markdown/0-community.md index 0b819f14d..cdac51e4e 100644 --- a/src/site/markdown/0-community.md +++ b/src/site/markdown/0-community.md @@ -21,7 +21,36 @@ Community {#community} limitations under the License. --> -See the following pages for community information: +# Getting help {#support} -* @subpage issue-tracking -* @subpage mailing-lists +If you are using an older version, search the [change log], [JIRA] and [mailing list archives] +to determine whether your problem has been fixed some time ago. + +If you already digged through the code and found a problem in the Log4cxx implementation +or the Log4cxx build scripts, feel free to directly raise an issue in [Github Issues]. +*Please don't just open bugs only because things don't work for you*, +some issues simply aren't bugs in the code base of the project or it's build tools, +but may have a lot of different other reasons. + +If things really only don't work and you don't have any clue why, +please use the [official support channels], +i.e., [usage mailing list](mailto:log4cxx-user@logging.apache.org), +[developer mailing lists](mailto:log4cxx-dev@logging.apache.org) +or [GitHub Discussions] instead. + +# Reporting a security issue {#security} + +Refer to the [official security page] for how to get support on security issues. + +# Official releases {#artifacts} + +See [artifact locations] for where you can get offical release artifacts and how to verify them. + +[change log]:@ref changelog +[JIRA]: https://issues.apache.org/jira/browse/LOGCXX +[mailing list archives]: http://mail-archives.apache.org/mod_mbox/logging-log4cxx-user +[Github Issues]: https://github.com/apache/logging-log4cxx/issues +[GitHub Discussions]: https://github.com/apache/logging-log4cxx/discussions +[official support channels]: https://logging.apache.org/support.html +[official security page]: https://logging.apache.org/security.html +[artifact locations]: https://logging.apache.org/download.html diff --git a/src/site/markdown/4-build.md b/src/site/markdown/4-build.md index 7d126c16a..c41c9e4ff 100644 --- a/src/site/markdown/4-build.md +++ b/src/site/markdown/4-build.md @@ -24,7 +24,7 @@ Build {#build} As of version 0.11.0, the only supported build system for Log4cxx is CMake. Have a look at the [Building with CMake] page for more information. If you have trouble building, either [create an issue] -or send a message to the [users mailing list]. +or send a message to the [users mailing list](mailto:log4cxx-user@logging.apache.org). See the following pages for information on building Log4cxx: @@ -35,4 +35,3 @@ See the following pages for information on building Log4cxx: [Building with CMake]:@ref build-cmake [create an issue]: https://github.com/apache/logging-log4cxx/issues -[users mailing list]:@ref mailing-lists diff --git a/src/site/markdown/change-report-gh.md b/src/site/markdown/change-report-gh.md index b11a019a0..fac0390de 100644 --- a/src/site/markdown/change-report-gh.md +++ b/src/site/markdown/change-report-gh.md @@ -1,4 +1,4 @@ -Changelog {#changelog} +Change Log {#changelog} === -# Release History +## Release History {#history} | Version | Date | Description | | ------------------- | ---------- | -------------------- | @@ -110,8 +110,9 @@ make them ABI stable * Multiprocess support is available, but Log4cxx must be explicitly compiled with this option Full release notes are below: -Bug ---- + +### Bug {#rel_1_0_0_bugs} + - \[[LOGCXX-432](https://issues.apache.org/jira/browse/LOGCXX-432)\] - AsyncAppender automatically switches to sync mode when e.g. there is @@ -124,8 +125,7 @@ Bug - \[[LOGCXX-563](https://issues.apache.org/jira/browse/LOGCXX-563)\] - Fix memory leaks -New Feature ------------ +### New Feature {#rel_1_0_0_features} - \[[LOGCXX-514](https://issues.apache.org/jira/browse/LOGCXX-514)\] - Create a libfmt layout @@ -134,8 +134,7 @@ New Feature - \[[LOGCXX-559](https://issues.apache.org/jira/browse/LOGCXX-559)\] - Implement LocationInfoFilter -Improvement ------------ +### Improvement {#rel_1_0_0_improvements} - \[[LOGCXX-516](https://issues.apache.org/jira/browse/LOGCXX-516)\] - Make classes ABI-stable @@ -178,8 +177,7 @@ ability to block signals from threads that the library creates, automatic creation of log directories, new color patterns, and the ability to determine the library version at compile and run-time. -Bug ---- +### Bug {#rel_13_0_bugs} - \[[LOGCXX-102](https://issues.apache.org/jira/browse/LOGCXX-102)\] - PropertyConfigurator does not process the RollingFileAppender @@ -207,14 +205,12 @@ Bug - \[[LOGCXX-546](https://issues.apache.org/jira/browse/LOGCXX-546)\] - Multi threaded applications run at single threaded speed -New Feature ------------ +### New Feature {#rel_13_0_features} - \[[LOGCXX-529](https://issues.apache.org/jira/browse/LOGCXX-529)\] - Support color and highlight conversion patterns -Improvement ------------ +### Improvement {#rel_13_0_improvements} - \[[LOGCXX-337](https://issues.apache.org/jira/browse/LOGCXX-337)\] - Suggested fix for socketappender not reconnecting multiple times @@ -229,8 +225,7 @@ Improvement - \[[LOGCXX-550](https://issues.apache.org/jira/browse/LOGCXX-550)\] - Add ability to get thread name not just ID -Wish ----- +### Wish {#rel_13_0_wish_list} - \[[LOGCXX-544](https://issues.apache.org/jira/browse/LOGCXX-544)\] - Please embedd library version in a header @@ -244,8 +239,7 @@ Wish This is a minor bugfix release to fix issues found with 0.12.0. Notably, this version fixes a bug where a multithreaded application would crash when using a rolling file. -Bug ---- +### Bug {#rel_12_1_bugs} - \[[LOGCXX-534](https://issues.apache.org/jira/browse/LOGCXX-534)\] - Crashed in log->forcedLog function when running with multi-thread @@ -281,8 +275,7 @@ AppenderPtr appender = log4cxx::cast(instance); // both point at the same object. ``` -Bug ---- +### Bug {#rel_12_0_bugs} - \[[LOGCXX-322](https://issues.apache.org/jira/browse/LOGCXX-322)\] - Crashes on exit from multithreaded program using log4cxx @@ -303,15 +296,10 @@ Bug - \[[LOGCXX-526](https://issues.apache.org/jira/browse/LOGCXX-526)\] - GCC-11.1.0 Support -New Feature ------------ +### New Feature {#rel_12_0_features} - \[[LOGCXX-515](https://issues.apache.org/jira/browse/LOGCXX-515)\] - Add macros to utilize libfmt formatting for messages - -Improvement ------------ - - \[[LOGCXX-523](https://issues.apache.org/jira/browse/LOGCXX-523)\] - Add in error handling for rollover errors diff --git a/src/site/markdown/community/issue-tracking.md b/src/site/markdown/community/issue-tracking.md deleted file mode 100644 index a0a3aec84..000000000 --- a/src/site/markdown/community/issue-tracking.md +++ /dev/null @@ -1,59 +0,0 @@ -Issue Tracking {#issue-tracking} -=== - - -# Overview - -This project uses [JIRA](https://www.atlassian.com/software/jira), a J2EE-based issue tracking -and project management application. Issues may also be filed through GitHub. - -# Issue Tracking - -*Bugs* and *feature requests* should be submitted to the following issue tracking system -for this project. - -https://issues.apache.org/jira/browse/LOGCXX - -If you do not have a JIRA account, you may email private@logging.apache.org due to the -Apache Software Foundation restricting signups([more information](https://infra.apache.org/jira-guidelines.html#who)). - -Issues may also be filed via the github mirror: - -https://github.com/apache/logging-log4cxx/issues - -*Please don't just open bugs only because things don't work for you*, some issues simply -aren't bugs in the code base of the project or it's build tools, but may have a lot of -different other reasons. If things don't work for you and you need some help, please subscribe -to the [users mailing list] and describe -the issue you have, the more detailed the better. The mailing list is a far better place to -discuss things than JIRA, besides that there are more users than developers of the project and -issues created in JIRA are only forwarded to the latter. There's always the chance to create an -issue in JIRA later, hopefully with a specific explanation of the problem and even a solution -already. - -As a rule of thumb, if you already digged through the code and found a problem in it or its -build tools, feel free to directly create a bug in [JIRA](https://issues.apache.org/jira/browse/LOGCXX). -But if things really only don't work and you don't have any clue why, please use the [users mailing list] -instead. - -Thanks! - -[users mailing list]:@ref mailing-lists diff --git a/src/site/markdown/community/mailing-lists.md b/src/site/markdown/community/mailing-lists.md deleted file mode 100644 index 5d1377f9b..000000000 --- a/src/site/markdown/community/mailing-lists.md +++ /dev/null @@ -1,38 +0,0 @@ -Mailing Lists {#mailing-lists} -=== - - -These are the mailing lists that have been established for -this project. For each list, there is a subscribe, unsubscribe, and an -archive link. -| | | | | | | -| -------------------------------------------- | ------------------------------------------------------------- | ----------------------------------------------------------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------- | -| Name | Subscribe | Unsubscribe | Post | Archive | Other Archives | -| Log4cxx usage | [Subscribe](mailto:log4cxx-user-subscribe@logging.apache.org) | [Unsubscribe](mailto:log4cxx-user-unsubscribe@logging.apache.org) | [Post](mailto:log4cxx-user@logging.apache.org) | [mail-archives.apache.org](http://mail-archives.apache.org/mod_mbox/logging-log4cxx-user/) | [markmail.org](http://markmail.org/search/list:org.apache.logging.log4cxx-user) | -| \- | \- | \- | \- | \- | [marc.info](http://marc.info/?l=log4cxx-user) | -| \- | \- | \- | \- | \- | [dir.gmane.org](http://dir.gmane.org/gmane.comp.apache.logging.log4cxx.user) | -| Log4cxx development | [Subscribe](mailto:dev-subscribe@logging.apache.org) | [Unsubscribe](mailto:dev-unsubscribe@logging.apache.org) | [Post](mailto:dev@logging.apache.org) | [mail-archives.apache.org](http://mail-archives.apache.org/mod_mbox/logging-dev/) | [markmail.org](http://markmail.org/search/list:org.apache.logging.dev) | -| \- | \- | \- | \- | \- | [marc.info](http://marc.info/?l=dev) | -| \- | \- | \- | \- | \- | [dir.gmane.org](http://dir.gmane.org/gmane.comp.apache.logging.devel) | -| Old Log4cxx development (NOT USED ANYMORE\!) | [Subscribe](mailto:log4cxx-dev-subscribe@logging.apache.org) | [Unsubscribe](mailto:log4cxx-dev-unsubscribe@logging.apache.org) | [Post](mailto:log4cxx-dev@logging.apache.org) | [mail-archives.apache.org](http://mail-archives.apache.org/mod_mbox/logging-log4cxx-dev/) | [markmail.org](http://markmail.org/search/list:org.apache.logging.log4cxx-dev) | -| \- | \- | \- | \- | \- | [marc.info](http://marc.info/?l=log4cxx-dev) | -| \- | \- | \- | \- | \- | [dir.gmane.org](http://dir.gmane.org/gmane.comp.apache.logging.log4cxx.devel) | -