From 574e7ee8a2973eea04792c17fb680621fa68c65c Mon Sep 17 00:00:00 2001 From: ayushjariyal Date: Thu, 21 Aug 2025 10:01:57 +0530 Subject: [PATCH 1/3] Bump markdownlint-cli --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 214e5c6039..40b92732d1 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -39,7 +39,7 @@ repos: args: [--install-types, --non-interactive, --config=pyproject.toml] - repo: https://github.com/igorshubovych/markdownlint-cli - rev: v0.43.0 + rev: v0.44.0 hooks: - id: markdownlint args: ["--fix"] From 9adc2521f974aa1e975f95d8f867303783a43aa2 Mon Sep 17 00:00:00 2001 From: ayushjariyal Date: Thu, 21 Aug 2025 19:52:27 +0530 Subject: [PATCH 2/3] Bump markdownlint-cli and update Markdown files manually --- .github/pull_request_template.md | 4 ++-- .pre-commit-config.yaml | 2 +- README.md | 2 +- mkdocs/docs/how-to-release.md | 2 +- mkdocs/docs/verify-release.md | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index afcc22b98a..0e5a489f89 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -7,8 +7,8 @@ Thanks for opening a pull request! # Rationale for this change -# Are these changes tested? +## Are these changes tested? -# Are there any user-facing changes? +## Are there any user-facing changes? diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 40b92732d1..7c0a1ac0f5 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -39,7 +39,7 @@ repos: args: [--install-types, --non-interactive, --config=pyproject.toml] - repo: https://github.com/igorshubovych/markdownlint-cli - rev: v0.44.0 + rev: v0.45.0 hooks: - id: markdownlint args: ["--fix"] diff --git a/README.md b/README.md index 11af8f08f8..b94bb7bbe4 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,6 @@ PyIceberg is a Python library for programmatic access to Iceberg table metadata The documentation is available at [https://py.iceberg.apache.org/](https://py.iceberg.apache.org/). -# Get in Touch +## Get in Touch - [Iceberg community](https://iceberg.apache.org/community/) diff --git a/mkdocs/docs/how-to-release.md b/mkdocs/docs/how-to-release.md index 1747c08348..cd957fd1f6 100644 --- a/mkdocs/docs/how-to-release.md +++ b/mkdocs/docs/how-to-release.md @@ -397,7 +397,7 @@ Ensure to update the `PYICEBERG_VERSION` in the [Dockerfile](https://github.com/ ### Set up GPG key and Upload to Apache Iceberg KEYS file -To set up GPG key locally, see the instructions [here](http://www.apache.org/dev/openpgp.html#key-gen-generate-key). +To set up GPG key locally, see the instructions [instructions link](http://www.apache.org/dev/openpgp.html#key-gen-generate-key). To install gpg on a M1 based Mac, a couple of additional steps are required: . diff --git a/mkdocs/docs/verify-release.md b/mkdocs/docs/verify-release.md index 6148bfebdb..fe00d3e730 100644 --- a/mkdocs/docs/verify-release.md +++ b/mkdocs/docs/verify-release.md @@ -113,7 +113,7 @@ make test-coverage This will spin up Docker containers to facilitate running test coverage. -# Cast the vote +## Cast the vote Votes are cast by replying to the release candidate announcement email on the dev mailing list with either `+1`, `0`, or `-1`. For example : From d1bc8095c410769242dc91c85fb3566f06238c83 Mon Sep 17 00:00:00 2001 From: Fokko Driesprong Date: Thu, 21 Aug 2025 23:19:29 +0200 Subject: [PATCH 3/3] Remove duplicate instructions --- mkdocs/docs/how-to-release.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs/docs/how-to-release.md b/mkdocs/docs/how-to-release.md index cd957fd1f6..3f533699d5 100644 --- a/mkdocs/docs/how-to-release.md +++ b/mkdocs/docs/how-to-release.md @@ -397,7 +397,7 @@ Ensure to update the `PYICEBERG_VERSION` in the [Dockerfile](https://github.com/ ### Set up GPG key and Upload to Apache Iceberg KEYS file -To set up GPG key locally, see the instructions [instructions link](http://www.apache.org/dev/openpgp.html#key-gen-generate-key). +To set up GPG key locally, see the [instructions](http://www.apache.org/dev/openpgp.html#key-gen-generate-key). To install gpg on a M1 based Mac, a couple of additional steps are required: .