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

GH-38209: [Docs] Reduce width of header items and keep header height default (small) on smaller screens #38148

Merged
merged 2 commits into from
Oct 11, 2023

Conversation

AlenkaF
Copy link
Member

@AlenkaF AlenkaF commented Oct 9, 2023

Rationale for this change

The Sphinx theme we have been using (PyData Sphinx Theme) has been pinned to an older version for a while now and with the #36591 we have updated the code and are now using version 0.14.0 for the dev docs.

This PR fixes bugs we have encountered after the PR updating the theme has been merged.

What changes are included in this PR?

  • Have default header size for smaller screens and keep it increased for bigger screens.

/* Make headings more bold */
--pst-font-weight-heading: 600;
}

/* Change header hight to make the logo a bit larger */
/* only on wider screens */
@media only screen and (min-width: 950px){
Copy link
Member

Choose a reason for hiding this comment

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

How did you decide on the min width of 950? From doing a quick experiment with the "Responsive design mode" in Firefox, I already see it wraparound (causing a very large header) at a width of around 1380 px

Copy link
Member

Choose a reason for hiding this comment

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

Or this is only for the "mobile" layout? (where there is no header at all anymore, except for the logo and expand buttons)

I indeed suggested on the issue to do this in this case, but, we can maybe also already do it when you are on a normal but small screen, i.e. for the cases where all the header navbar items are visible, but start to wrap around because there is not enough space, like:

image

Copy link
Member Author

Choose a reason for hiding this comment

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

I am not sure this will help any as the version switcher and search buttons are already causing issues (see pydata/pydata-sphinx-theme#1493 (comment)), but am trying locally now to see.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ok, setting the minimum width of the screen to have the bigger header height to 1380px gave me two layouts to compare as the limit for the double header is a bit higher:

  • just under 1380px and smaller header height:

Screenshot 2023-10-09 at 11 08 31

  • just over 1380px and bigger header height:

Screenshot 2023-10-09 at 11 08 23

I agree the smaller header size is better in this case also (double navbar), but the logo is too small to read it and that is not something I would keep.

I propose to have the bigger header height for 1400px but in the case of default header height I would use a different logo: Chevron-only logo

@github-actions github-actions bot added awaiting changes Awaiting changes and removed awaiting review Awaiting review labels Oct 9, 2023
@AlenkaF
Copy link
Member Author

AlenkaF commented Oct 11, 2023

@jorisvandenbossche I changed "Specifications and Protocol" to just "Specifications" and "Language implementations" to just "Implementations". Then the double header comes up at approx 1170px and that is when we default back to the smaller header size.

I would still change the logo to Chevron-only in the smaller header case as the current one is not readable on smaller screens.

@github-actions github-actions bot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Oct 11, 2023
@AlenkaF AlenkaF marked this pull request as ready for review October 11, 2023 10:16
@jorisvandenbossche
Copy link
Member

I would still change the logo to Chevron-only in the smaller header case as the current one is not readable on smaller screens.

It's only the "Apache" part that is not readable, right? I agree it doesn't look great with the Apache not being readable, but on the other hand I think it is nice you still see "Arrow" .. (but I suppose having a logo with just Arrow without Apache will violate the rules of how the name should be used)

@jorisvandenbossche jorisvandenbossche changed the title GH-37947:[Docs] Keep header size default (small) on smaller screens GH-37947: [Docs] Reduce width of header items and keep header height default (small) on smaller screens Oct 11, 2023
@AlenkaF
Copy link
Member Author

AlenkaF commented Oct 11, 2023

It's only the "Apache" part that is not readable, right?

Yes, correct.

I agree it doesn't look great with the Apache not being readable, but on the other hand I think it is nice you still see "Arrow" .. (but I suppose having a logo with just Arrow without Apache will violate the rules of how the name should be used)

I do not think it is violating, Apache is still there, it is just very small and I think in that case using only chevron without Apache Arrow would be better. But I understand, Arrow will then not be there, which is a bummer.

No rush to change though. We can decide for 15.0.0 and have the header change included in 14.0.0.

@jorisvandenbossche jorisvandenbossche changed the title GH-37947: [Docs] Reduce width of header items and keep header height default (small) on smaller screens GH-38209: [Docs] Reduce width of header items and keep header height default (small) on smaller screens Oct 11, 2023
@jorisvandenbossche jorisvandenbossche merged commit 1cc0f14 into apache:main Oct 11, 2023
9 of 11 checks passed
@jorisvandenbossche jorisvandenbossche removed the awaiting change review Awaiting change review label Oct 11, 2023
@github-actions
Copy link

⚠️ GitHub issue #38209 has been automatically assigned in GitHub to PR creator.

raulcd pushed a commit that referenced this pull request Oct 12, 2023
…default (small) on smaller screens (#38148)

### Rationale for this change

The Sphinx theme we have been using (PyData Sphinx Theme) has been pinned to an older version for a while now and with the #36591 we have updated the code and are now using version 0.14.0 for the dev docs.

This PR fixes bugs we have encountered after the PR updating the theme has been merged.

### What changes are included in this PR?

- Have default header size for smaller screens and keep it increased for bigger screens.

* Closes: #38209

Authored-by: AlenkaF <[email protected]>
Signed-off-by: Joris Van den Bossche <[email protected]>
llama90 pushed a commit to llama90/arrow that referenced this pull request Oct 12, 2023
…eight default (small) on smaller screens (apache#38148)

### Rationale for this change

The Sphinx theme we have been using (PyData Sphinx Theme) has been pinned to an older version for a while now and with the apache#36591 we have updated the code and are now using version 0.14.0 for the dev docs.

This PR fixes bugs we have encountered after the PR updating the theme has been merged.

### What changes are included in this PR?

- Have default header size for smaller screens and keep it increased for bigger screens.

* Closes: apache#38209

Authored-by: AlenkaF <[email protected]>
Signed-off-by: Joris Van den Bossche <[email protected]>
@conbench-apache-arrow
Copy link

After merging your PR, Conbench analyzed the 5 benchmarking runs that have been run so far on merge-commit 1cc0f14.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

JerAguilon pushed a commit to JerAguilon/arrow that referenced this pull request Oct 23, 2023
…eight default (small) on smaller screens (apache#38148)

### Rationale for this change

The Sphinx theme we have been using (PyData Sphinx Theme) has been pinned to an older version for a while now and with the apache#36591 we have updated the code and are now using version 0.14.0 for the dev docs.

This PR fixes bugs we have encountered after the PR updating the theme has been merged.

### What changes are included in this PR?

- Have default header size for smaller screens and keep it increased for bigger screens.

* Closes: apache#38209

Authored-by: AlenkaF <[email protected]>
Signed-off-by: Joris Van den Bossche <[email protected]>
loicalleyne pushed a commit to loicalleyne/arrow that referenced this pull request Nov 13, 2023
…eight default (small) on smaller screens (apache#38148)

### Rationale for this change

The Sphinx theme we have been using (PyData Sphinx Theme) has been pinned to an older version for a while now and with the apache#36591 we have updated the code and are now using version 0.14.0 for the dev docs.

This PR fixes bugs we have encountered after the PR updating the theme has been merged.

### What changes are included in this PR?

- Have default header size for smaller screens and keep it increased for bigger screens.

* Closes: apache#38209

Authored-by: AlenkaF <[email protected]>
Signed-off-by: Joris Van den Bossche <[email protected]>
@AlenkaF AlenkaF deleted the gh-37947-new-theme-bug-fix branch December 13, 2023 14:12
dgreiss pushed a commit to dgreiss/arrow that referenced this pull request Feb 19, 2024
…eight default (small) on smaller screens (apache#38148)

### Rationale for this change

The Sphinx theme we have been using (PyData Sphinx Theme) has been pinned to an older version for a while now and with the apache#36591 we have updated the code and are now using version 0.14.0 for the dev docs.

This PR fixes bugs we have encountered after the PR updating the theme has been merged.

### What changes are included in this PR?

- Have default header size for smaller screens and keep it increased for bigger screens.

* Closes: apache#38209

Authored-by: AlenkaF <[email protected]>
Signed-off-by: Joris Van den Bossche <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] Reduce width of header items and keep header height default (small) on smaller screens
2 participants