(iceberg) branch main updated: Docs: Fix list rendering and typos (#13214) (#13267)

[ke...@apache.org]

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

kevinjqliu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iceberg.git


The following commit(s) were added to refs/heads/main by this push:
     new a8d111eaa7 Docs: Fix list rendering and typos (#13214) (#13267)
a8d111eaa7 is described below

commit a8d111eaa7bfb3f98a236578cee3b2ff14b7b338
Author: Raman Yelianevich <ra...@gmail.com>
AuthorDate: Thu Jun 12 17:39:51 2025 +0200

    Docs: Fix list rendering and typos (#13214) (#13267)
    
    Co-authored-by: Raman Yelianevich <ry...@theworkshop.com>
---
 docs/docs/aws.md           | 2 ++
 docs/docs/flink-writes.md  | 8 +++++---
 docs/docs/hive.md          | 2 ++
 docs/docs/spark-queries.md | 7 ++++---
 site/README.md             | 6 +++---
 5 files changed, 16 insertions(+), 9 deletions(-)

diff --git a/docs/docs/aws.md b/docs/docs/aws.md
index 2f790aa70e..b6123a6ae9 100644
--- a/docs/docs/aws.md
+++ b/docs/docs/aws.md
@@ -382,7 +382,9 @@ s3://my-table-data-bucket/my_ns.db/my_table/0101/0110/1001/10110010/category=ord
 ```
 
 Note, the path resolution logic for `ObjectStoreLocationProvider` is `write.data.path` then `<tableLocation>/data`.
+
 However, for the older versions up to 0.12.0, the logic is as follows:
+
 - before 0.12.0, `write.object-storage.path` must be set.
 - at 0.12.0, `write.object-storage.path` then `write.folder-storage.path` then `<tableLocation>/data`.
 - at 2.0.0 `write.object-storage.path` and `write.folder-storage.path` will be removed
diff --git a/docs/docs/flink-writes.md b/docs/docs/flink-writes.md
index c3f68e23f1..d3a077dc0c 100644
--- a/docs/docs/flink-writes.md
+++ b/docs/docs/flink-writes.md
@@ -391,6 +391,8 @@ SET table.exec.iceberg.use-v2-sink = true;
 ## Writing with DataStream
 
 To use SinkV2 based implementation, replace `FlinkSink` with `IcebergSink` in the provided snippets.
-Warning: There are some slight differences between these implementations:
-- The `RANGE` distribution mode is not yet available for the `IcebergSink`
-- When using `IcebergSink` use `uidSuffix` instead of the `uidPrefix`
+!!! warning
+    There are some slight differences between these implementations:
+
+     - The `RANGE` distribution mode is not yet available for the `IcebergSink`
+     - When using `IcebergSink` use `uidSuffix` instead of the `uidPrefix`
diff --git a/docs/docs/hive.md b/docs/docs/hive.md
index b6b90b4b04..0b775618b3 100644
--- a/docs/docs/hive.md
+++ b/docs/docs/hive.md
@@ -386,6 +386,7 @@ ALTER TABLE orders REPLACE COLUMNS (remaining string);
 
 #### Partition evolution
 You change the partitioning schema using the following commands:
+
 * Change the partitioning schema to new identity partitions:
 ```sql
 ALTER TABLE default.customers SET PARTITION SPEC (last_name);
@@ -394,6 +395,7 @@ ALTER TABLE default.customers SET PARTITION SPEC (last_name);
 ```sql
 ALTER TABLE order SET PARTITION SPEC (month(ts));
 ```
+
 #### Table migration
 You can migrate Avro / Parquet / ORC external tables to Iceberg tables using the following command:
 ```sql
diff --git a/docs/docs/spark-queries.md b/docs/docs/spark-queries.md
index a13002481d..eb3ed9708e 100644
--- a/docs/docs/spark-queries.md
+++ b/docs/docs/spark-queries.md
@@ -327,9 +327,10 @@ SELECT * FROM prod.db.table.files;
 
 !!! info
     Content refers to type of content stored by the data file:
-      * 0  Data
-      * 1  Position Deletes
-      * 2  Equality Deletes
+
+      - 0 - Data
+      - 1 - Position Deletes
+      - 2 - Equality Deletes
 
 To show only data files or delete files, query `prod.db.table.data_files` and `prod.db.table.delete_files` respectively.
 To show all files, data files and delete files across all tracked snapshots, query `prod.db.table.all_files`, `prod.db.table.all_data_files` and `prod.db.table.all_delete_files` respectively.
diff --git a/site/README.md b/site/README.md
index 97ddddc5cd..c618b177f4 100644
--- a/site/README.md
+++ b/site/README.md
@@ -115,7 +115,7 @@ make clean
 
 #### Testing local changes on versioned docs
 
-When you build the docs as described above, by default the versioned docs are mounted from the upstream remote repositiory called `iceberg_docs`. One exception is the `nightly` version that is a soft link to the local `docs/` folder.
+When you build the docs as described above, by default the versioned docs are mounted from the upstream remote repository called `iceberg_docs`. One exception is the `nightly` version that is a soft link to the local `docs/` folder.
 
 When you make changes to some of the historical versioned docs in a local git branch you can mount this git branch instead of the remote one by setting the following environment variables:
 
@@ -125,7 +125,7 @@ When you make changes to some of the historical versioned docs in a local git br
 
 #### Offline mode
 
-One of the great advantages to the MkDocs material plugin is the [offline feature](https://squidfunk.github.io/mkdocs-material/plugins/offline). You can view the Iceberg docs without the need of a server. To enable OFFLINE builds, add theOFFLINE environment variable to either `build` or `serve` recipes.
+One of the great advantages to the MkDocs material plugin is the [offline feature](https://squidfunk.github.io/mkdocs-material/plugins/offline). You can view the Iceberg docs without the need of a server. To enable OFFLINE builds, add the OFFLINE environment variable to either `build` or `serve` recipes.
 
 ```sh
 make build OFFLINE=true
@@ -136,7 +136,7 @@ make build OFFLINE=true
 
 ## Release process
 
-Deploying the docs is a two step process:
+Deploying the docs is a two-step process:
 
 > [!WARNING]  
 > The `make release` directive is currently unavailable as we wanted to discuss the best way forward on how or if we should automate the release. It involves taking an existing snapshot of the versioned documentation, and potentially automerging the [`docs` branch](https://github.com/apache/iceberg/tree/docs) and the [`javadoc` branch](https://github.com/apache/iceberg/tree/javadoc) which are independent from the `main` branch. Once this is complete, we can create a pull request with an  [...]