(logging-parent) 01/02: Improve release instructions

[vy...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

vy pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/logging-parent.git

commit 46f8ee670071773695ea408c96ae987d03f7f590
Author: Volkan Yazıcı <vo...@yazi.ci>
AuthorDate: Mon Apr 15 12:22:27 2024 +0200

    Improve release instructions
---
 .../modules/ROOT/pages/release-instructions-project.adoc     | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/src/site/antora/modules/ROOT/pages/release-instructions-project.adoc b/src/site/antora/modules/ROOT/pages/release-instructions-project.adoc
index 0f4a4b2..9363ef9 100644
--- a/src/site/antora/modules/ROOT/pages/release-instructions-project.adoc
+++ b/src/site/antora/modules/ROOT/pages/release-instructions-project.adoc
@@ -30,8 +30,16 @@ This section explains how to publish a new release of projects extending from th
 
 [WARNING]
 ====
-In the code examples below, assuming that the project and its version to be published are `{project-id}` and `7.8.0`, respectively.
-You need to adapt these values for your project and version accordingly.
+Shared instructions hardcode the following constants:
+
+Project ID::
+`{project-id}`
+
+Project version::
+`7.8.0`
+
+**You must adapt these values for your project!**
+For instance, project ID needs to be replaced with `log4j` for Log4j, `log4j-kotlin` for Log4j Kotlin, etc.
 ====
 
 [#stage-release]