[Meta] New documentation site M1

[tkajtoch]

Note

This meta issue tracks the effort of developing the new EUI documentation site only. Check out the Elastic Design System - Milestone 2 for more.

Summary

With the transition to EUI being a part of the Elastic Design System, we want to improve how we create, maintain, and publish our docs.

Goals

• Replace the current website with a shiny new one based on docusaurus (check out the ADR why we chose docusaurus - Elastic internal only) while keeping the content mostly the same
  • We plan to reorganize and rewrite content in further milestones
• Reduce the complexity of writing and maintaining docs by converting them to MDX
• Convert all component examples to use interactive component previews based on react-live (or similar)
• Add full-text search capabilities
• Add Storybook playgrounds for all EUI components

Definition of Done

• The new documentation site is deployed in place of the current one (https://eui.elastic.co) and is publicly accessible
• The new documentation site passes manual QA and accessibility tests
• Buildkite pipelines are updated to build and publish the new website on every EUI release

---

Meta issues

Preview Give feedback

1. [Meta] [New docs] Playground stories for all EUI components #7405
   233 of 242
   New EUI site meta +2
   
2. [Meta] [New docs] Custom docusaurus theme #7432
   9 of 9
   New EUI site meta task +3
3. [Meta] [New docs] Full-text search #7753
   1 of 1
   New EUI site meta task +3
   
4. [Meta] [New docs] Publish Elastic Design System patterns #7754
   New EUI site meta task +3
   
5. [Meta] [New docs] Convert components docs text content to MDX #7404
   110 of 229
   New EUI site meta task +3
6. [Meta] [New docs] Port dynamic documentation pages to docusaurus #7433
   0 of 3
   New EUI site task +2

Issues

Preview Give feedback

1. feat: setup new docs #7386
   +0
   
2. [New docs] Build and deploy docusaurus on every buildkite docs deployment #7402
   New EUI site +1
   
3. [New docs] Move docusaurus website to packages directory #7644
   New EUI site blocked task +3
   
4. [New docs] Create StoryEmbed component #7393
   New EUI site task +2
   
5. [New docs] Convert EuiComboBox docs to docusaurus and storybook #7394
   New EUI site +1
   
6. [New docs] Spike: Figure out the best way to integrate full-text search into new docs #7407
   New EUI site task +2
7. [EUI+] Missing guidelines content #8192
   New EUI site task +2
   
8. [EUI+] Missing Theming content #8189
   New EUI site task +2
   
9. [EUI+] Missing Utilities content #8190
   New EUI site task +2
   
10. [EUI+] [EuiDataGrid] Fix issues with the component docs #8143
    New EUI site bug task +3
11. [EUI+] [EuiHorizontalRule] Fix issues with the component docs #8144
    New EUI site bug task +3
12. [EUI+] [EuiLink] Fix issues with the component docs #8145
    New EUI site bug task +3
13. [EUI+] [EuiTreeView] Fix issues with the component docs #8146
    New EUI site bug task +3
14. [EUI+] [EuiCodeBlock] Fix issues with the component docs #8147
    New EUI site bug task +3
15. [EUI+] [EuiSteps] Fix issues with the component docs #8148
    New EUI site bug task +3
16. [EUI+] [EuiComboBox] Fix issues with the component docs #8149
    New EUI site bug task +3
17. [EUI+] [EuiSkeleton] Fix issues with the component docs #8150
    New EUI site bug task +3
18. [EUI+] [EuiStat] Fix issues with the component docs #8152
    New EUI site bug task +3
19. [EUI+] [EuiPage] Fix issues with the component docs #8153
    New EUI site bug task +3
20. [EUI+] Fix missing subdued background colors #8154
    New EUI site bug task +3
21. [EUI+] [EuiBottomBar] The displacement example is broken #8165
    New EUI site bug task +3
22. [EUI+] [EuiPageTemplate] The examples are incorrect / broken #8164
    New EUI site bug task +3
23. [EUI+] Rethink and update fullscreen demos #8151
    New EUI site task +2
24. [EUI+] The right sidebar with page navigation gets pushed down #8161
    New EUI site task +2
25. [EUI+] [EuiTable] The examples are suffering from responsive width issues #8166
    New EUI site bug task +3
26. [EUI+] Docasaurus theme styles affect EUI examples #8167
    New EUI site bug task +3
27. [EUI+] Investigate pages freezing on dev during HMR #8155
    New EUI site task +2
28. [EUI+] Investigate lazy loading interactive examples #8156
    New EUI site task +2
29. [EUI+] Prop tables don't provide enough space for the prop names #8159
    New EUI site bug task +3
30. [EUI+] Fix all broken links #8158
    New EUI site bug task +3
    
31. [EUI+] Reorganise the document pages #8163
    New EUI site task +2
32. [EUI+] Missing Utilities content #8188
    New EUI site task +2