Skip to content

Commit 91e21cb

Browse files
committed
docs: address review feedback on Parquet and Iceberg pages
- Revert the prettier reformat of expressions.md, keeping only the link change - Move the field-id read entry to Parquet's Known Issues - Redirect removed pages to the matching section, keeping deep-link anchors - Point both Known Issues sections at the S3 and Azure limitations - Rename the S3 and Azure Limitations headings for stable anchors - State that the native Parquet writer is for testing only and list its scope - Link the duplicated scan-time error entries instead of repeating them
1 parent 2d23998 commit 91e21cb

6 files changed

Lines changed: 557 additions & 529 deletions

File tree

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<!--
2+
Licensed to the Apache Software Foundation (ASF) under one
3+
or more contributor license agreements. See the NOTICE file
4+
distributed with this work for additional information
5+
regarding copyright ownership. The ASF licenses this file
6+
to you under the Apache License, Version 2.0 (the
7+
"License"); you may not use this file except in compliance
8+
with the License. You may obtain a copy of the License at
9+
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed to in writing,
13+
software distributed under the License is distributed on an
14+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
KIND, either express or implied. See the License for the
16+
specific language governing permissions and limitations
17+
under the License.
18+
-->
19+
20+
<html><head><noscript><meta http-equiv="refresh" content="0; url=${to_uri}" /></noscript><script>var target = "${to_uri}";if (window.location.hash) {window.location.replace(target.split("#")[0] + window.location.hash);} else {window.location.replace(target);}</script></head></html>

‎docs/source/conf.py‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,10 @@
186186
# enable nice rendering of checkboxes for the task lists
187187
myst_enable_extensions = ["colon_fence", "deflist", "tasklist"]
188188

189+
# Like the extension's default template, but when the old URL carries an anchor, the anchor
190+
# replaces any anchor in the target, so deep links into a moved page still land on their section.
191+
redirect_html_template_file = "_templates/redirect.html"
192+
189193
redirects = {
190194
"overview.html": "index.html",
191195
"gluten_comparison.html": "about/gluten_comparison.html",
@@ -206,9 +210,9 @@
206210
# The compatibility guide became a directory of pages in #4055.
207211
"user-guide/latest/compatibility.html": "compatibility/index.html",
208212
# Parquet and Iceberg documentation was consolidated into one page each.
209-
"user-guide/latest/compatibility/scans.html": "../parquet.html",
210-
"user-guide/latest/compatibility/parquet-iceberg-known-issues.html": "../parquet.html",
211-
"user-guide/latest/tuning/scans.html": "../parquet.html",
213+
"user-guide/latest/compatibility/scans.html": "../parquet.html#reading",
214+
"user-guide/latest/compatibility/parquet-iceberg-known-issues.html": "../parquet.html#known-issues",
215+
"user-guide/latest/tuning/scans.html": "../parquet.html#tuning",
212216
"user-guide/latest/iceberg-writes.html": "iceberg.html",
213217
}
214218

‎docs/source/user-guide/latest/datasources.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ the HDFS read itself, typically while an unrelated query is running.
151151
```
152152

153153
Native Iceberg scans do not support HDFS-backed tables; those scans fall back to Spark. See the
154-
[Iceberg](iceberg.md).
154+
[Iceberg](iceberg.md) page.
155155

156156
### Building Comet with HDFS support
157157

@@ -416,7 +416,7 @@ $SPARK_HOME/bin/spark-shell \
416416
...
417417
```
418418

419-
### Limitations
419+
### S3 Limitations
420420

421421
Comet's S3 support has the following limitations:
422422

@@ -543,7 +543,7 @@ Comet 1.1 started from the environment and overlaid the Hadoop keys it found by
543543
- A lower-case `oauth` auth type, or OAuth keys without `fs.azure.account.auth.type`, fail the way they fail for Spark. In the second case Hadoop defaults to `SharedKey` and the key provider fails. On hadoop-azure 3.4.1 and later the driver log names the missing key. 3.3.4 reports only `Failure to initialize configuration`.
544544
- A configured mechanism the native scan cannot build fails with an error instead of silently reading the environment.
545545

546-
### Limitations
546+
### Azure Limitations
547547

548548
1. **Authentication keys only**: Only the keys in the table above reach the native store. Other `fs.azure.*` settings (read-ahead, retries, HTTP tuning) do not apply to the native scan.
549549

0 commit comments

Comments
 (0)