[SPARK-46546][DOCS] Fix the formatting of tables in `running-on-yarn` pages #44540

panbingkun · 2023-12-30T02:07:01Z

What changes were proposed in this pull request?

The pr aims to fix the formatting of tables in running-on-yarn pages.

Why are the changes needed?

Make the tables on the page display normally.
Before:

After:

Does this PR introduce any user-facing change?

No.

How was this patch tested?

Manually check.

Was this patch authored or co-authored using generative AI tooling?

No.

…netes` and `running-on-yarn` pages

panbingkun · 2023-12-30T02:12:04Z

1.https://spark.apache.org/docs/latest/running-on-kubernetes.html#configuration
Before:

After:

2.https://spark.apache.org/docs/latest/running-on-yarn.html#spark-properties
Before:

After:

panbingkun · 2023-12-30T02:15:40Z

cc @zhengruifeng @HyukjinKwon @dongjoon-hyun @LuciferYang

nchammas · 2023-12-30T05:45:52Z

I think a better approach to fixing the styling of tables is to assign them to a class and then define the appropriate rules in custom.css. It will be much simpler and more robust than manually massaging the contents of each cell.

I was planning to do this as a follow-up to #44300 if it gets approved, but feel free obviously to try that here if you agree.

bjornjorgensen · 2023-12-31T21:01:15Z

There are actually more places where this issue are. Like in GROUP BY Clause for spark 3.5
where is looks like this

panbingkun · 2024-01-02T02:10:18Z

I will define a style in the file custom.css and try it out.

yaooqinn · 2024-01-02T10:32:25Z

Hi @panbingkun, the scrollbar has been fixed. FYI,#44423

panbingkun · 2024-01-02T10:45:41Z

Hi @panbingkun, the scrollbar has been fixed. FYI,#44423

@yaooqinn
Okay, but I generated a document with the latest code a few days ago, and the table format seems to be incorrect.

panbingkun · 2024-01-03T08:49:03Z

Hi @panbingkun, the scrollbar has been fixed. FYI,#44423

@yaooqinn Okay, but I generated a document with the latest code a few days ago, and the table format seems to be incorrect.

@yaooqinn
Indeed, I just checked again and the master's logic is now scrollable.
But I found another issue, I will reuse this PR and modify the following issue:

This reverts commit d8c5460.

…on-kubernetes` and `running-on-yarn` pages" This reverts commit 674496d.

…ages

yaooqinn · 2024-01-03T09:04:20Z

@panbingkun, thank you for the double check

yaooqinn · 2024-01-03T09:06:24Z

docs/running-on-yarn.md

    initialization. This prevents application failures caused by running containers on
    NodeManagers where the Spark Shuffle Service is not running.
  </td>
+  <td></td>


Please ensure that the value is fulfilled.

Okay, let me find the versions of each option.

panbingkun · 2024-01-03T09:15:39Z

docs/running-on-yarn.md

-<thead><tr><th>Property Name</th><th>Default</th><th>Meaning</th></tr></thead>
+<thead><tr><th>Property Name</th><th>Default</th><th>Meaning</th><th>Since Version</th></tr></thead>
 <tr>
  <td><code>spark.yarn.shuffle.stopOnFailure</code></td>


PR: https://github.com/apache/spark/pull/14162/files#diff-71e304edb6adff7be2edd8855cd040b965240627aa6ebe5b5e941b2fc41e090dR75
Starting from the following version of the document: https://spark.apache.org/docs/2.1.0/running-on-yarn.html
branch 2.0(non-exist): https://github.com/apache/spark/blob/branch-2.0/docs/running-on-yarn.md?plain=1
branch 2.1(exist): https://github.com/apache/spark/blob/branch-2.1/docs/running-on-yarn.md?plain=1

=> 2.1.0

panbingkun · 2024-01-03T09:27:11Z

docs/running-on-yarn.md

+  <td></td>
 </tr>
 <tr>
  <td><code>spark.yarn.shuffle.service.metrics.namespace</code></td>


PR: https://github.com/apache/spark/pull/31936/files#diff-71e304edb6adff7be2edd8855cd040b965240627aa6ebe5b5e941b2fc41e090dR105
Starting from the following version of the document: https://spark.apache.org/docs/3.2.0/running-on-yarn.html
branch-3.1(non-exist): https://github.com/apache/spark/blob/branch-3.1/docs/running-on-yarn.md?plain=1
branch-3.2(exist): https://github.com/apache/spark/blob/branch-3.2/docs/running-on-yarn.md?plain=1

=> 3.2.0

panbingkun · 2024-01-03T09:28:49Z

docs/running-on-yarn.md

+  <td></td>
 </tr>
 <tr>
  <td><code>spark.yarn.shuffle.service.logs.namespace</code></td>


PR: https://github.com/apache/spark/pull/34079/files#diff-661e1c80840458affe09c28d71a7901d9bf15d6e87edd0c26dec1c8fd78b128aR810
Starting from the following version of the document: https://spark.apache.org/docs/3.3.0/running-on-yarn.html
branch-3.2(non-exist): https://github.com/apache/spark/blob/branch-3.2/docs/running-on-yarn.md?plain=1
branch-3.3(exist): https://github.com/apache/spark/blob/branch-3.3/docs/running-on-yarn.md?plain=1

=> 3.3.0

…ages

dongjoon-hyun

+1, LGTM. Merged to master/3.5.

… pages ### What changes were proposed in this pull request? The pr aims to fix the formatting of tables in `running-on-yarn` pages. ### Why are the changes needed? Make the tables on the page display normally. Before: <img width="1288" alt="image" src="https://github.com/apache/spark/assets/15246973/26facec4-d805-4549-a640-120c499bd7fd"> After: <img width="1310" alt="image" src="https://github.com/apache/spark/assets/15246973/cf6c20ef-a4ce-4532-9acd-ab9cec41881a"> ### Does this PR introduce _any_ user-facing change? No. ### How was this patch tested? Manually check. ### Was this patch authored or co-authored using generative AI tooling? No. Closes #44540 from panbingkun/SPARK-46546. Authored-by: panbingkun <[email protected]> Signed-off-by: Dongjoon Hyun <[email protected]> (cherry picked from commit 85b44cc) Signed-off-by: Dongjoon Hyun <[email protected]>

dongjoon-hyun · 2024-01-03T20:09:42Z

Thank you, @panbingkun and all.

[SPARK-46546][DOCS] Fix the formatting of tables in `running-on-kuber…

674496d

…netes` and `running-on-yarn` pages

github-actions bot added the DOCS label Dec 30, 2023

Make the table fixed width

d8c5460

panbingkun added 2 commits January 3, 2024 16:51

Revert "Make the table fixed width"

3635512

This reverts commit d8c5460.

Revert "[SPARK-46546][DOCS] Fix the formatting of tables in `running-…

cc11057

…on-kubernetes` and `running-on-yarn` pages" This reverts commit 674496d.

panbingkun changed the title ~~[SPARK-46546][DOCS] Fix the formatting of tables in running-on-kubernetes and running-on-yarn pages~~ [SPARK-46546][DOCS] Fix the formatting of tables in running-on-yarn pages Jan 3, 2024

[SPARK-46546][DOCS] Fix the formatting of tables in running-on-yarn p…

39a112d

…ages

yaooqinn reviewed Jan 3, 2024

View reviewed changes

panbingkun commented Jan 3, 2024

View reviewed changes

update

ca304b6

panbingkun commented Jan 3, 2024

View reviewed changes

[SPARK-46546][DOCS] Fix the formatting of tables in running-on-yarn p…

f87a260

…ages

yaooqinn approved these changes Jan 3, 2024

View reviewed changes

dongjoon-hyun approved these changes Jan 3, 2024

View reviewed changes

dongjoon-hyun closed this in 85b44cc Jan 3, 2024

[SPARK-46546][DOCS] Fix the formatting of tables in running-on-yarn pages #44540

[SPARK-46546][DOCS] Fix the formatting of tables in running-on-yarn pages #44540

Uh oh!

Conversation

panbingkun commented Dec 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What changes were proposed in this pull request?

Why are the changes needed?

Does this PR introduce any user-facing change?

How was this patch tested?

Was this patch authored or co-authored using generative AI tooling?

Uh oh!

panbingkun commented Dec 30, 2023

Uh oh!

panbingkun commented Dec 30, 2023

Uh oh!

nchammas commented Dec 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bjornjorgensen commented Dec 31, 2023

Uh oh!

panbingkun commented Jan 2, 2024

Uh oh!

yaooqinn commented Jan 2, 2024

Uh oh!

panbingkun commented Jan 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

panbingkun commented Jan 3, 2024

Uh oh!

yaooqinn commented Jan 3, 2024

Uh oh!

yaooqinn Jan 3, 2024

Choose a reason for hiding this comment

Uh oh!

LuciferYang Jan 3, 2024

Choose a reason for hiding this comment

Uh oh!

panbingkun Jan 3, 2024

Choose a reason for hiding this comment

Uh oh!

panbingkun Jan 3, 2024

Choose a reason for hiding this comment

Uh oh!

panbingkun Jan 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

panbingkun Jan 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

panbingkun Jan 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dongjoon-hyun left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dongjoon-hyun commented Jan 3, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

[SPARK-46546][DOCS] Fix the formatting of tables in `running-on-yarn` pages #44540

[SPARK-46546][DOCS] Fix the formatting of tables in `running-on-yarn` pages #44540

panbingkun commented Dec 30, 2023 •

edited

Loading

nchammas commented Dec 30, 2023 •

edited

Loading

panbingkun commented Jan 2, 2024 •

edited

Loading

panbingkun Jan 3, 2024 •

edited

Loading

panbingkun Jan 3, 2024 •

edited

Loading

panbingkun Jan 3, 2024 •

edited

Loading

dongjoon-hyun left a comment •

edited

Loading