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

feat: add a part of existing docs content to the new docs site #7417

Merged
merged 7 commits into from
Dec 18, 2023

Conversation

tkajtoch
Copy link
Member

@tkajtoch tkajtoch commented Dec 12, 2023

Summary

This PR adds MDX documentation content of the following components to the new docs site:

  • EuiAccordion
  • EuiBottomBar
  • EuiFlex family
  • EuiFlyout
  • EuiHeader
  • EuiHorizontalRule
  • EuiModal
  • EuiPageHeader
  • EuiPanel
  • EuiPopover
  • EuiResizableContainer
  • EuiSpacer
  • EuiBreadcrumbs
  • EuiButton
  • EuiCollapsibleNav
  • EuiComboBox
  • EuiContextMenu
  • EuiFacet
  • EuiKeyPadMenu
  • EuiLink
  • EuiPagination
  • EuiSideNav
  • EuiSteps
  • EuiTabs
  • EuiTreeView

This work is a part of #7404. The new docs added in this PR are missing component previews and examples that will be added separately as part of #7405.

QA

  • Open docusaurus PR preview page and ensure all of the components docs are rendered on the page

@tkajtoch tkajtoch self-assigned this Dec 12, 2023
@tkajtoch tkajtoch requested a review from a team as a code owner December 12, 2023 22:54
@JasonStoltz
Copy link
Member

@tkajtoch What should I expect to see at this point?

It looks like the page content is available, but without embedded code examples.

It also looks like embedded links are not working yet. Should I expect them to be?

Copy link
Contributor

@1Copenut 1Copenut left a comment

Choose a reason for hiding this comment

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

Left one comment about the missing link. Will review individual pages when build is passing.

<div className={styles.buttons}>
<Link
className="button button--secondary button--lg"
to="/docs/intro">
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this line here is the reason your build is failing @tkajtoch. I pulled the branch and started it locally, was able to recreate the missing page message.


Screenshot 2023-12-13 at 9 30 19 AM
Screenshot 2023-12-13 at 9 30 10 AM

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed in 99795b

Copy link
Contributor

Choose a reason for hiding this comment

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

Verified the fix works as expected and all pages render properly. 🚀

@tkajtoch tkajtoch mentioned this pull request Dec 14, 2023
1 task
@kibanamachine
Copy link

Preview staging links for this PR:

@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

History

cc @tkajtoch

@tkajtoch
Copy link
Member Author

@JasonStoltz Embedded code samples will be added in a separate PR. Links to other component docs will be updated when all docs are converted to MDX.

@tkajtoch tkajtoch merged commit 6f4db95 into elastic:feat/new-docs Dec 18, 2023
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.

5 participants