[logging-log4j-transform] 03/03: Update `README.adoc` and `RELEASING.adoc`

[vy...@apache.org]

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

vy pushed a commit to branch release/0.2.0
in repository https://gitbox.apache.org/repos/asf/logging-log4j-transform.git

commit ed433b25ef4ba182000c91b64eb508eb9f4d22a9
Author: Volkan Yazıcı <vo...@yazi.ci>
AuthorDate: Wed Sep 13 09:22:49 2023 +0200

    Update `README.adoc` and `RELEASING.adoc`
---
 README.adoc    | 14 ++++++++------
 RELEASING.adoc | 19 ++++++++++++++++---
 2 files changed, 24 insertions(+), 9 deletions(-)

diff --git a/README.adoc b/README.adoc
index 67c23c4..0384d68 100644
--- a/README.adoc
+++ b/README.adoc
@@ -28,7 +28,7 @@ a https://maven.apache.org/plugins/maven-shade-plugin/examples/resource-transfor
 
 == Build
 
-This project generates Java 8 bytecode, though requires Java 11 for compilation.
+This project generates Java 8 bytecode, though requires Java 17 for compilation.
 You can build and test sources using `./mvnw verify` command.
 
 == Distribution
@@ -36,25 +36,27 @@ You can build and test sources using `./mvnw verify` command.
 In accordance with the Apache Software Foundation's release https://infra.apache.org/release-distribution.html[distribution policy] and https://infra.apache.org/release-publishing.html[creation process], project artifacts are _officially_ accessible from the following locations:
 
 * ASF https://repository.apache.org/content/repositories/releases[Release] and https://repository.apache.org/content/repositories/snapshots[snapshot] repositories (mirrored to https://central.sonatype.dev/[the Maven Central Repository])
-* ASF https://downloads.apache.org/logging/log4j-transform[Distribution directory]
+* ASF https://downloads.apache.org/logging/logging-parent[Distribution directory]
 
 See xref:RELEASING.adoc[release instructions] for further details.
 
 == Support
 
+Please keep in mind that this project is intended for internal usage only.
 You can use GitHub Issues for feature requests and bug reports – not questions!
-For the rest, you can use mailto:security@logging.apache.org[the Log4j development mailing list].
+See https://logging.apache.org/log4j/2.x/support.html[the Log4j support policy] for details.
 
 == Security
 
 If you have encountered an unlisted security vulnerability or other unexpected behaviour that has security impact, please report them privately to mailto:security@logging.apache.org[the Log4j security mailing list].
 See https://logging.apache.org/log4j/2.x/security.html[the Log4j Security page] for further details.
+
 == License
 
 Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
-See the NOTICE file distributed with this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
-You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0[].
+See xref:NOTICE.txt[] distributed with this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0[].
 
 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and limitations under the License.
diff --git a/RELEASING.adoc b/RELEASING.adoc
index 20316ae..8621915 100644
--- a/RELEASING.adoc
+++ b/RELEASING.adoc
@@ -99,19 +99,32 @@ I will continue the release process.
 === In the git repository
 
 . Pull the most recent changes and tags
++
+[source,bash]
+----
+git fetch -p
+----
 . Tag the release (e.g., `rel/7.8.0`) and push it
 +
 [source,bash]
 ----
-git tag -a rel/7.8.0 <COMMIT-ID> -m 7.8.0
+git tag -a rel/7.8.0 <COMMIT-ID> -m 7.8.0     # <1>
 git push origin rel/7.8.0
 ----
 +
+<1> You can find the `COMMIT-ID` in the generated vote email.
++
 [IMPORTANT]
 ====
 The ASF infrastructure treats ``rel/``-prefixed git tags special and ensures they are immutable for provenance reasons.
 ====
 . Merge `release/7.8.0` to `main`
++
+[source,bash]
+----
+git checkout main
+git merge release/7.8.0
+----
 . Set the revision property to the next development version (e.g., `7.9.0-SNAPSHOT`) in xref:pom.xml[`pom.xml`]
 . Commit changes and push the `main` branch
 . Delete the local and remote copies of the `release/7.8.0` branch
@@ -121,9 +134,9 @@ The ASF infrastructure treats ``rel/``-prefixed git tags special and ensures the
 . _Release_ the repository in https://reporter.apache.org/addrelease.html?logging[repository.apache.org]
 . In https://dist.apache.org/repos/dist/release/logging/{project-name}[dist.apache.org/repos/dist] Subversion repository,
 .. create the `*release*/logging/{project-name}/7.8.0` folder, and copy the signed sources and their checksum from `*dev*/logging/{project-name}` to there
-.. delete the folder from an earlier release in `*release*/logging/{project-name}`
+.. delete the folder from an earlier release in `*release*/logging/{project-name}` (stash the generated announcement email somewhere, you will need it later on)
 .. commit changes
-. Report the release at https://reporter.apache.org/[reporter.apache.org]
+. Report the release at https://reporter.apache.org/addrelease.html?logging[reporter.apache.org]
 
 === In GitHub