Skip to content

Docs: Fix list rendering and typos (#13075) #13267

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 12, 2025

Conversation

yelianevich
Copy link
Contributor

@yelianevich yelianevich commented Jun 7, 2025

Fixes #13075

The issue with rendering list is related to a missing blank line between paragraphs and lists. I found more similar issues and fixed them in this PR as well.

Here are the screenshots of the fixed lists from the local instance:

  1. Integrations / AWS:
image
  1. Flink / Flink Writes
image
  1. Hive
image
  1. Spark / Queries (original example of the issue)
image

@github-actions github-actions bot added the docs label Jun 7, 2025
@yelianevich yelianevich changed the title Docs: Fix list rendering and typos (#13214) Docs: Fix list rendering and typos (#13075) Jun 7, 2025
@manuzhang manuzhang requested review from Fokko and kevinjqliu June 10, 2025 02:25
Copy link
Contributor

@kevinjqliu kevinjqliu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! I ran this locally and attached the screenshots.

One interesting observation is that the new changes only show up in nightly, i.e. http://127.0.0.1:8000/docs/nightly/spark-queries/#files

@@ -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`.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshot 2025-06-12 at 8 35 17 AM

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshot 2025-06-12 at 8 35 41 AM

@@ -386,6 +386,7 @@ ALTER TABLE orders REPLACE COLUMNS (remaining string);

#### Partition evolution
You change the partitioning schema using the following commands:

Copy link
Contributor

@kevinjqliu kevinjqliu Jun 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshot 2025-06-12 at 8 39 36 AM

* 0 Data
* 1 Position Deletes
* 2 Equality Deletes

Copy link
Contributor

@kevinjqliu kevinjqliu Jun 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshot 2025-06-12 at 8 39 19 AM

@kevinjqliu kevinjqliu merged commit a8d111e into apache:main Jun 12, 2025
2 checks passed
@kevinjqliu
Copy link
Contributor

Thank you for fixing the docs @yelianevich, much appreciated :) And thanks everyone else for the review

@yelianevich yelianevich deleted the improvement/fix-list-docs-13075 branch June 12, 2025 19:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix list in docs
4 participants