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

docs: Add latest components MDX content #8095

Merged
merged 16 commits into from
Oct 28, 2024

Conversation

tkajtoch
Copy link
Member

Summary

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

This adds the latest components docs files and renames the 02_components directory to components for easier reordering if needed. All of the content comes from https://eui.elastic.co and doesn't need to be proofread as part of the review process as it was already previously reviewed.

I recommend reviewing commit by commit. This branch also includes a couple of code changes, specifically updating the list styles to be compatible with EUI styling and adding a utility Example component used in the theming and utilities docs sections.

QA

  • Confirm the CI passes
  • Confirm the website loads correctly and contains added MDX files

@tkajtoch tkajtoch self-assigned this Oct 23, 2024
@tkajtoch tkajtoch requested a review from a team as a code owner October 23, 2024 12:45
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.

I noticed some code examples that didn't work:

And a couple additional pages that look like something is not properly parsed:

};
};

const ExampleDescription = ({ children }: PropsWithChildren) => children;
Copy link
Contributor

Choose a reason for hiding this comment

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

🗒️ We discussed the purpose of these shell components, and agreed to add a comment for context.


```

## Column widths
Copy link
Contributor

Choose a reason for hiding this comment

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

🗒️ As disussed, we added an additional section in the old docs for draggable columns that's missing here still.


import Link from '@docusaurus/Link';

# Header
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure this is expected but the header component here is global and to me it wasn't intuitive since the example container is empty 🤔

Screenshot 2024-10-23 at 17 33 50

@tkajtoch
Copy link
Member Author

@mgadewoll all things from your list should be fixed now. Most of them were fixed by simply exposing DisplayToggles

@mgadewoll
Copy link
Contributor

@tkajtoch I still noticed some issues.

  1. There are still a some code examples not working:
  1. I also noticed there are default appearances for form elements shown here. Maybe we're missing some more reset styles? 🤔

Screenshot 2024-10-24 at 09 34 42

  1. And I realized that table components look a bit off. They have global styles applied from the docs page 🫠

Screenshot 2024-10-24 at 09 40 47

Screenshot 2024-10-24 at 09 38 00

Screenshot 2024-10-24 at 09 40 15

@mgadewoll
Copy link
Contributor

@tkajtoch I missed another broken code example before:

@mgadewoll
Copy link
Contributor

@tkajtoch Is it expected that the "Utilities" section is missing in the new docs? 🤔

Screenshot 2024-10-25 at 14 08 01

@mgadewoll
Copy link
Contributor

@tkajtoch This is unrelated to the content changes, but I figured I pin it here anyway:
The content has a max-width of 830px for viewports > 997px.
This can cause layout breaks - the right sidebar moves down - when the content is using all of the 830px and the combined width (the right sidebar has 25% width) exceeds the viewport width.

Screenshot 2024-10-26 at 13 23 08

I think we might want to reduce the content max-width, at least for the problematic viewport range.

@kibanamachine
Copy link

Preview staging links for this PR:

@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

History

cc @tkajtoch

@tkajtoch
Copy link
Member Author

The remaining content fixes and improvements will be added as separate PRs. We discussed it's best to merge this PR as-is and continue working in more focused branches

@tkajtoch tkajtoch merged commit 32ced41 into elastic:main Oct 28, 2024
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