Skip to content
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

[SPARK-46637][DOCS] Enhancing the Visual Appeal of Spark doc website #44642

Closed
wants to merge 4 commits into from

Conversation

gengliangwang
Copy link
Member

@gengliangwang gengliangwang commented Jan 9, 2024

What changes were proposed in this pull request?

Enhance the Visual Appeal of Spark doc website after #40269:

1. There is a weird indent on the top right side of the first paragraph of the Spark 3.5.0 doc overview page

Before this PR
image

After this PR:
image

2. All the titles are too big and therefore less readable. In the website https://spark.apache.org/downloads.html, titles are h2 while in doc site https://spark.apache.org/docs/latest/ titles are h1. So we should make the font size of titles smaller.

Before this PR:
image
After this PR:
image

3. The banner image can't be displayed correct. Even when it shows up, it will be hover by the text. To make it simple, let's not show the banner image as we did in https://spark.apache.org/docs/3.4.2/

image image

Why are the changes needed?

Improve the Visual Appeal of Spark doc website

Does this PR introduce any user-facing change?

No

How was this patch tested?

Manually build doc and verify on local setup.

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

No

@gengliangwang
Copy link
Member Author

cc @grundprinzip @allanf-db as well

@grundprinzip
Copy link
Contributor

Actually this lost the hero banner somewhere. When I migrated the CSS for the docs I added the
image
image to the CSS seems that this got lost somehow.

@gengliangwang
Copy link
Member Author

@grundprinzip yes I am aware of that. See the PR description

  1. The banner image can't be displayed correct. Even when it shows up, it will be hover by the text. To make it simple, let's not show the banner image as we did in https://spark.apache.org/docs/3.4.2/

for details. Having the image in https://spark.apache.org/ should be enough.

@HyukjinKwon HyukjinKwon changed the title [SPARK-46637][Doc] Enhancing the Visual Appeal of Spark doc website [SPARK-46637][DOCS] Enhancing the Visual Appeal of Spark doc website Jan 10, 2024
@HyukjinKwon
Copy link
Member

Merged to master.

gengliangwang added a commit that referenced this pull request Jan 10, 2024
### What changes were proposed in this pull request?

Enhance the Visual Appeal of Spark doc website after #40269:
#### 1. There is a weird indent on the top right side of the first paragraph of the Spark 3.5.0 doc overview page
Before this PR
<img width="680" alt="image" src="https://github.com/apache/spark/assets/1097932/84d21ca1-a4d0-4bd4-8f20-a34fa5db4000">

After this PR:
<img width="1035" alt="image" src="https://github.com/apache/spark/assets/1097932/4ffc0d5a-ed75-44c5-b20a-475ff401afa8">

#### 2. All the titles are too big and therefore less readable. In the website https://spark.apache.org/downloads.html, titles are h2 while in doc site https://spark.apache.org/docs/latest/ titles are h1. So we should make the font size of titles smaller.
Before this PR:
<img width="935" alt="image" src="https://github.com/apache/spark/assets/1097932/5bbbd9eb-432a-42c0-98be-ff00a9099cd6">
After this PR:
<img width="965" alt="image" src="https://github.com/apache/spark/assets/1097932/dc94c1fb-6ac1-41a8-b4a4-19b3034125d7">

#### 3. The banner image can't be displayed correct. Even when it shows up, it will be hover by the text. To make it simple, let's not show the banner image as we did in https://spark.apache.org/docs/3.4.2/
<img width="570" alt="image" src="https://github.com/apache/spark/assets/1097932/f6d34261-a352-44e2-9633-6e96b311a0b3">
<img width="1228" alt="image" src="https://github.com/apache/spark/assets/1097932/c49ce6b6-13d9-4d8f-97a9-7ed8b037be57">

### Why are the changes needed?

Improve the Visual Appeal of Spark doc website

### Does this PR introduce _any_ user-facing change?

No

### How was this patch tested?

Manually build doc and verify on local setup.

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

No

Closes #44642 from gengliangwang/enhance_doc.

Authored-by: Gengliang Wang <gengliang@apache.org>
Signed-off-by: Hyukjin Kwon <gurwls223@apache.org>
@gengliangwang
Copy link
Member Author

@HyukjinKwon Thanks for merging the PR. I just pushed it to branch-3.5 as well: d3e3084

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
4 participants