Skip to content

Commit

Permalink
Minor documentation fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
vy committed Sep 29, 2023
1 parent a69609b commit 1c51793
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 5 deletions.
2 changes: 1 addition & 1 deletion src/changelog/.index.adoc.ftl
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
////

[#release-notes]
=== Release Notes
== Release Notes

<#list releases as release><#if release.changelogEntryCount gt 0>
include::_release-notes/_${release.version}.adoc[]
Expand Down
4 changes: 2 additions & 2 deletions src/site/_log4j-changelog-maven-plugin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ limitations under the License.
This project ships a Maven plugin providing access to the `ChangelogExporter` and `ChangelogReleaser` of xref:#log4j-changelog[`log4j-changelog`].
[#log4j-changelog-dependencies]
== Dependencies
[#log4j-changelog-maven-plugin-dependencies]
=== Dependencies
You need to have the `org.apache.logging.log4j:log4j-changelog-maven-plugin` dependency in your classpath:
Expand Down
4 changes: 3 additions & 1 deletion src/site/_log4j-changelog.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This project contains tools to maintain changelogs.
It is designed for Apache Log4j, but can be used for any Java project.
[#log4j-changelog-dependencies]
== Dependencies
=== Dependencies
You need to have the `org.apache.logging.log4j:log4j-changelog` dependency in your classpath:
Expand All @@ -35,6 +35,8 @@ You need to have the `org.apache.logging.log4j:log4j-changelog` dependency in yo
</dependency>
----
Java module name and OSGi `Bundle-SymbolicName` are set to `org.apache.logging.log4j.changelog`.
[#log4j-changelog-what-is-a-changelog]
=== What is a changelog?
Expand Down
2 changes: 1 addition & 1 deletion src/site/_release-notes/_0.x.x.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ This minor release contains various bug fixes and improvements.
==== Changed
* Bump the default `log4j-changelog` XML schema version to `0.1.2`
* Made `author` element optional and bumped the XML schema version to `0.1.2`

0 comments on commit 1c51793

Please sign in to comment.