andygrove opened a new pull request, #7090:
URL: https://github.com/apache/datafusion-comet/pull/7090

   ## Which issue does this PR close?
   
   N/A. Documentation restructure.
   
   ## Rationale for this change
   
   Documentation for the Parquet and Iceberg data sources was spread over seven 
pages: `compatibility/scans.md`, `tuning/scans.md`, 
`compatibility/parquet-iceberg-known-issues.md`, `iceberg.md`, 
`iceberg-writes.md`, and the Parquet and Iceberg blurbs in `datasources.md`. 
The same facts were repeated in several of them, Iceberg and Delta sat under 
Integrations beside Celeborn and Kubernetes, and a reader looking for 
everything about one format had to visit several pages.
   
   ## What changes are included in this PR?
   
   - New `parquet.md`: Reading (what falls back, what errors at scan time, 
schema-mismatch handling), Writing, Tuning, and Known Issues. Replaces 
`compatibility/scans.md`, `tuning/scans.md`, and the Parquet half of the 
known-issues page. Text is moved, not rewritten.
   - `iceberg.md` now covers reading, a Writes section (all of 
`iceberg-writes.md`, headings demoted one level so anchors are unchanged), and 
Known Issues (the Iceberg half of the known-issues page, including the "not 
Comet bugs" list). The duplicate Iceberg scan tuning is dropped.
   - The object store and credential entries from the known-issues page apply 
to storage, not to a format, so they move to the S3 and Azure Limitations lists 
in `datasources.md`.
   - New "Data Sources" section in the user guide: Supported Data Sources, 
Parquet, Apache Iceberg, Delta Lake, S3 Credential Providers. Integrations now 
holds Celeborn and Kubernetes. The scan and known-issues entries leave the 
Compatibility and Tuning sections.
   - The tuning guide links to the Parquet and Iceberg tuning sections as 
separate entries.
   - Links updated in the user guide, FAQ, Gluten comparison, contributor 
guide, and the `review-comet-iceberg-write-pr` skill. `conf.py` redirects cover 
the four removed URLs.
   
   Four Scala files (`IcebergWriteProtoTranslation.scala`, 
`CometIcebergWriteActionSuite.scala`, and the two Iceberg benchmarks) still 
mention `iceberg-writes.md` in comments. I left them alone so this docs-only 
change does not trigger the Scala CI tiers.
   
   ## How are these changes tested?
   
   Documentation only. I checked every relative link and anchor under 
`docs/source` with a script and ran `prettier --check` on the changed files. 
The Sphinx build was not run locally (Sphinx is not installed here), so please 
check the docs build in CI.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to