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

[New docs] Global site and docusaurus theme improvements #8093

Merged
merged 13 commits into from
Oct 23, 2024

Conversation

tkajtoch
Copy link
Member

Summary

This PR is part of https://github.com/elastic/eui-private/issues/137.

This PR delivers a set of global improvements to the EUI+ site. It updates the docusaurus theme with new Guideline and GuidelineText components that are used to create guidelines pages, adds copyright headers to files that miss it, and fixes a few minor issues within the EUI+ website. The Guideline component is based on our existing Guideline components.

This is a base for the content update PRs. Expect the Components section to be empty and the search to be broken due to a missing markdown class - these will be addressed in follow-up PRs to keep things relatively small.

QA

  • Ensure the EUI+ website is building properly

@tkajtoch tkajtoch self-assigned this Oct 21, 2024
@tkajtoch tkajtoch requested a review from a team as a code owner October 21, 2024 14:17
Copy link
Contributor

@mgadewoll mgadewoll left a comment

Choose a reason for hiding this comment

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

Going over the page, I noticed some a couple of visual things (not sure when they were introduced):

  • On the homepage the cards have a double border

Screenshot 2024-10-22 at 09 38 56

  • dark mode doesn't fully apply on homepage (It works as expected on main)

Screenshot 2024-10-22 at 09 44 33

  • The main nav has too much content for smaller viewports (I guess we need to break to mobile layout for it earlier)

Screenshot 2024-10-22 at 09 43 43

@@ -40,7 +40,7 @@ export default function DocRootLayout({ children }: Props): JSX.Element {
window.location.hash.substring(1),
);
element?.scrollIntoView(true);
Copy link
Contributor

Choose a reason for hiding this comment

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

❓ Does this actually scroll for you?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, it works as expected 🤔

@kibanamachine
Copy link

Preview staging links for this PR:

@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

History

cc @tkajtoch

Copy link
Contributor

@mgadewoll mgadewoll left a comment

Choose a reason for hiding this comment

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

There are still questions open about the double border and main nav responsive breakpoint (mentioned here) but apart from it, the page builds as expected now.

To not block this PR, I'll approve it but either still here or as follow-up we should address those visual regressions, imho.

@tkajtoch
Copy link
Member Author

I can confirm the page header overflows when resizing. I can't reproduce the double border issue anymore - let's chat about it during our sync later today! I'm going to merge this PR and address these issues separately

@tkajtoch tkajtoch merged commit 4a36358 into elastic:main Oct 23, 2024
4 of 5 checks passed
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.

4 participants