Skip to content

Commit 3c7c279

Browse files
authored
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. -->
1 parent 370e770 commit 3c7c279

File tree

4 files changed

+12
-6
lines changed

4 files changed

+12
-6
lines changed

.asf.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
# https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features
2222

2323
github:
24-
description: "Apache PyIceberg"
24+
description: "PyIceberg"
2525
homepage: https://py.iceberg.apache.org/
2626
labels:
2727
- iceberg

mkdocs/docs/how-to-release.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ export LAST_COMMIT_ID=$(git rev-list ${GIT_TAG} 2> /dev/null | head -n 1)
232232

233233
cat << EOF > release-announcement-email.txt
234234
235-
Subject: [VOTE] Release Apache PyIceberg $VERSION_WITH_RC
235+
Subject: [VOTE] PyIceberg $VERSION_WITH_RC
236236
Hi Everyone,
237237
238238
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:
351351

352352
```text
353353
354-
Subject: [ANNOUNCE] Apache PyIceberg release <VERSION>
354+
Subject: [ANNOUNCE] PyIceberg <VERSION>
355355
356-
I'm pleased to announce the release of Apache PyIceberg <VERSION>!
356+
I'm pleased to announce the release of PyIceberg <VERSION>!
357357
358358
Apache Iceberg is an open table format for huge analytic datasets. Iceberg
359359
delivers high query performance for tables with tens of petabytes of data,

mkdocs/docs/verify-release.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
# Verifying a release
2121

22-
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.
22+
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.
2323

2424
In addition to testing in downstream projects, community members also check the release’s signatures, checksums, and license documentation.
2525

@@ -48,13 +48,18 @@ Set an environment variable to the version to verify and path to use
4848

4949
```sh
5050
export PYICEBERG_VERSION=<version> # e.g. 0.6.1rc3
51+
```
52+
53+
And a temp folder for the artifacts
54+
55+
```sh
5156
export PYICEBERG_VERIFICATION_DIR=/tmp/pyiceberg/${PYICEBERG_VERSION}
5257
```
5358

5459
Next, verify the `.asc` file.
5560

5661
```sh
57-
svn checkout https://dist.apache.org/repos/dist/dev/iceberg/pyiceberg-${PYICEBERG_VERSION}/ ${PYICEBERG_VERIFICATION_DIR}
62+
svn checkout https://dist.apache.org/repos/dist/dev/iceberg/pyiceberg-$PYICEBERG_VERSION/ ${PYICEBERG_VERIFICATION_DIR}
5863

5964
cd ${PYICEBERG_VERIFICATION_DIR}
6065

mkdocs/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ theme:
4444
- navigation.tracking
4545
- navigation.tabs
4646
- navigation.tabs.sticky
47+
- content.code.copy # Enables the copy button
4748
palette:
4849
- scheme: default
4950
toggle:

0 commit comments

Comments
 (0)