Docusaurus theme updates for release

[weronikaolejniczak]

Summary

On this PR, I prepare docusaurus-theme to be released and consumed by other teams at Elastic.

Changes

• removed eui-docgen dependency
• made VersionSwitcher
• refactor VersionSwitcher usage
• made PropsTable reusable
• extend the theme PropsTable
• removed incorrect @elastic/eui imports from severity pattern
• updated broken documentation links
  • fixed links in the data grid container constraints
• added license headers to all relevant files
• added license field and files
• package.json to be ready for package release

I recommend going commit by commit.

Tip

You can read more about Swizzling component here.

Why are we making this change?

https://github.com/elastic/eui-private/issues/150 - we want to publish packages/docusaurus-theme so it can be consumed by other teams at Elastic, e.g. Kibana.

Screenshots

Incorrect links

Incorrect imports

Much better...

Impact to users

🟢 This is not a breaking change. The documentation website behavior should remain the same.

QA

1. Checkout this branch: gh pr checkout 8814
2. Install dependencies: yarn
3. Build documentation page workspaces: yarn workspace @elastic/eui-website build:workspaces
4. Start the documentation page: yarn workspace @elastic/eui-website start

Checklist:

• Version switcher works as expected
• Prop tables render as expected
• The links in prop tables work
• Example demos work as expected
• Codesandbox functionality works as expected
• Color mode toggles as expected

Optionally:

• Verify that there are no broken link warnings when running the dev server
• Build packages/docusaurus-theme and use in a Docusaurus scaffolding (Refer to README.md for instructions)

[mgadewoll]

ℹ️ The commit links in the description would need an update, they change when force pushing 😅

[mgadewoll]

Build packages/docusaurus-theme and use in a Docusaurus scaffolding

💭 Providing steps would make QA more clear and streamlined here. What's required to configure the theme setup? What other dependencies would need to be installed? etc.

[weronikaolejniczak]

💭 Providing steps would make QA more clear and streamlined here.

The reason why I didn't provide them is because we've discussed this topic with @tkajtoch and I was expecting a review from him. So I made a mental shortcut in the QA section because he'd know exactly how to test this.

Now that you want to test it, which I'm grateful for, I can spend some time on writing a more detailed description. That being said, I'll ask you for your patience because this PR is of lesser priority like we discussed, and I have some other high priorities I need to handle at the moment.

I will just ping you whenever you can review the PR again 😄 Thanks!

[weronikaolejniczak]

Now I noticed the footer isn't rendering correctly (not sure why but locally it showed up correctly for me after the change). Working on it.

[mgadewoll]

@weronikaolejniczak The additional added changes make sense and look good to me. Thanks for adding them!
Let me know if you'll add any further changes (colorMode, footer) or if the existing changes are the full set and I'll review or approve accordingly. 👍

[weronikaolejniczak]

@mgadewoll the PR is ready to be re-reviewed. Everything should be working as expected in our documentation website.

[elasticmachine]

💚 Build Succeeded

• Buildkite Build
• Commit: 0ed33c8
• Documentation website
• Storybook

History

• 💚 Build #1534 succeeded 67c3fa1
• 💚 Build #1244 succeeded 90e183f
• 💚 Build #1225 succeeded f2c99c3
• 💚 Build #1224 succeeded 23f332c
• 💚 Build #1219 succeeded 9c3986e
• 💚 Build #1193 succeeded dab6dd6

cc @weronikaolejniczak

[elasticmachine]

💚 Build Succeeded

• Buildkite Build
• Commit: 0ed33c8

History

• 💚 Build #4919 succeeded 67c3fa1
• 💚 Build #4714 succeeded 90e183f
• 💚 Build #4704 succeeded f2c99c3
• 💚 Build #4703 succeeded 23f332c
• 💚 Build #4698 succeeded 9c3986e
• 💚 Build #4676 succeeded dab6dd6

cc @weronikaolejniczak

[mgadewoll]

🟢 All changes are LGTM and the documentation page works as expected.
Thanks for your diligent work and patience on this! 🎉