vpelikh opened a new pull request, #4230: URL: https://github.com/apache/logging-log4j2/pull/4230
This PR ports the documentation updates from [PR #2696](https://github.com/apache/logging-log4j2/pull/2696) to the current `main` branch. The original [PR #2716](https://github.com/apache/logging-log4j2/pull/2716) was inactive for 2 years. I picked it up, cherry-picked its commits, and addressed all outstanding review comments. ## Changes (5 commits) ### 1. Revamp pages (Volkan Yazıcı) - Rewrote `architecture.adoc`, `extending.adoc`, `plugins.adoc`, `customconfig.adoc` with updated content - Updated `dependencyinjection.adoc` with restructured sections (Overview, Injection Points, Names/Qualifiers, Scopes, etc.) - Added example files for custom configuration (XML, JSON, YAML, Properties, Java) - Removed deprecated `articles.adoc`, `thanks.adoc`, `Log4jClasses.jpg` - Updated cross-references across related doc pages ### 2. Update plugin manual for 3.x plugin API (Matt Sicker) - Updated `plugins.adoc` to use `@Plugin` + `@Configurable` + `@Namespace` pattern instead of `@Plugin(category=...)` - Updated Javadoc links from `log4j-core` to `log4j-plugins` - Fixed `RequiredClass.java` Javadoc ### 3. Update plugins, extending, DI docs (Matt Sicker) - Updated `appenders.adoc`, `filters.adoc`, `lookups.adoc` plugin annotation references - Updated `configuration.adoc` with extension point documentation - Updated `dependencyinjection.adoc`, `extending.adoc`, `layouts.adoc` ### 4. Fix typo (Matt Sicker) - Fixed `denots the the` → `denotes` in `pattern-layout.adoc` ### 5. Address review comments (Vasily Pelikh) - Updated `XmlConfigurationFactory` (order 5) and `JsonConfigurationFactory` (order 6) from `@Order` to `@Ordered` - `OrderComparator` now supports both `@Order` (legacy) and `@Ordered` (new) via `AnnotationUtil.getOrder()` - Updated `ExampleConfigurationFactory.java` from `@Plugin(category=...)` + `@Order` → `@Plugin` + `@Namespace` + `@Ordered` - Added conditional annotations section to `plugins.adoc` (`@ConditionalOnMissingBinding`, `@ConditionalOnPresentBindings`) - Enhanced `@PluginAliases` documentation in `plugins.adoc` with examples ## Review status All items from [the review comment](https://github.com/apache/logging-log4j2/pull/2716#issuecomment-2253492850) have been addressed. -- 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]
