This is an automated email from the ASF dual-hosted git repository.
fokko pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iceberg-python.git
The following commit(s) were added to refs/heads/main by this push:
new 3c7c279d docs: improve release docs (#2374)
3c7c279d is described below
commit 3c7c279d5a61f724e1e00b960691c509f0c758c7
Author: Kevin Liu <kevinjq...@users.noreply.github.com>
AuthorDate: Thu Aug 28 00:51:49 2025 -0700
docs: improve release docs (#2374)
<!--
Thanks for opening a pull request!
-->
<!-- In the case this PR will resolve an issue, please replace
${GITHUB_ISSUE_ID} below with the actual Github issue id. -->
<!-- Closes #${GITHUB_ISSUE_ID} -->
# Rationale for this change
Minor quality of life changes to release docs
* Added a copy button to script lines
<img width="818" height="515" alt="Screenshot 2025-08-22 at 12 15 46 PM"
src="https://github.com/user-attachments/assets/87569d80-6a48-4dcd-b307-bd7b3ff84235";
/>
* `Apache PyIceberg` -> `PyIceberg`. "Apache PyIceberg" sounds like a
top-level, standalone project. I prefer we use use just "PyIceberg"
## Are these changes tested?
## Are there any user-facing changes?
<!-- In the case of user-facing changes, please add the changelog label.
-->
---
.asf.yaml | 2 +-
mkdocs/docs/how-to-release.md | 6 +++---
mkdocs/docs/verify-release.md | 9 +++++++--
mkdocs/mkdocs.yml | 1 +
4 files changed, 12 insertions(+), 6 deletions(-)
diff --git a/.asf.yaml b/.asf.yaml
index 6dd2b794..1c632570 100644
--- a/.asf.yaml
+++ b/.asf.yaml
@@ -21,7 +21,7 @@
# https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features
github:
- description: "Apache PyIceberg"
+ description: "PyIceberg"
homepage: https://py.iceberg.apache.org/
labels:
- iceberg
diff --git a/mkdocs/docs/how-to-release.md b/mkdocs/docs/how-to-release.md
index 3f533699..a2fa3f70 100644
--- a/mkdocs/docs/how-to-release.md
+++ b/mkdocs/docs/how-to-release.md
@@ -232,7 +232,7 @@ export LAST_COMMIT_ID=$(git rev-list ${GIT_TAG} 2>
/dev/null | head -n 1)
cat << EOF > release-announcement-email.txt
To: d...@iceberg.apache.org
-Subject: [VOTE] Release Apache PyIceberg $VERSION_WITH_RC
+Subject: [VOTE] PyIceberg $VERSION_WITH_RC
Hi Everyone,
I propose that we release the following RC as the official PyIceberg $VERSION
release.
@@ -351,9 +351,9 @@ Send out an announcement on the dev mail list:
```text
To: d...@iceberg.apache.org
-Subject: [ANNOUNCE] Apache PyIceberg release <VERSION>
+Subject: [ANNOUNCE] PyIceberg <VERSION>
-I'm pleased to announce the release of Apache PyIceberg <VERSION>!
+I'm pleased to announce the release of PyIceberg <VERSION>!
Apache Iceberg is an open table format for huge analytic datasets. Iceberg
delivers high query performance for tables with tens of petabytes of data,
diff --git a/mkdocs/docs/verify-release.md b/mkdocs/docs/verify-release.md
index fe00d3e7..1844a9bc 100644
--- a/mkdocs/docs/verify-release.md
+++ b/mkdocs/docs/verify-release.md
@@ -19,7 +19,7 @@
# Verifying a release
-Each Apache PyIceberg release is validated by the community by holding a vote.
A community release manager will prepare a release candidate and call a vote on
the Iceberg dev list. To validate the release candidate, community members will
test it out in their downstream projects and environments.
+Each PyIceberg release is validated by the community by holding a vote. A
community release manager will prepare a release candidate and call a vote on
the Iceberg dev list. To validate the release candidate, community members will
test it out in their downstream projects and environments.
In addition to testing in downstream projects, community members also check
the release’s signatures, checksums, and license documentation.
@@ -48,13 +48,18 @@ Set an environment variable to the version to verify and
path to use
```sh
export PYICEBERG_VERSION=<version> # e.g. 0.6.1rc3
+```
+
+And a temp folder for the artifacts
+
+```sh
export PYICEBERG_VERIFICATION_DIR=/tmp/pyiceberg/${PYICEBERG_VERSION}
```
Next, verify the `.asc` file.
```sh
-svn checkout
https://dist.apache.org/repos/dist/dev/iceberg/pyiceberg-${PYICEBERG_VERSION}/
${PYICEBERG_VERIFICATION_DIR}
+svn checkout
https://dist.apache.org/repos/dist/dev/iceberg/pyiceberg-$PYICEBERG_VERSION/
${PYICEBERG_VERIFICATION_DIR}
cd ${PYICEBERG_VERIFICATION_DIR}
diff --git a/mkdocs/mkdocs.yml b/mkdocs/mkdocs.yml
index 679aff25..421a923a 100644
--- a/mkdocs/mkdocs.yml
+++ b/mkdocs/mkdocs.yml
@@ -44,6 +44,7 @@ theme:
- navigation.tracking
- navigation.tabs
- navigation.tabs.sticky
+ - content.code.copy # Enables the copy button
palette:
- scheme: default
toggle:
