Skip to content

[CoreRenderingService] Add dev docs #218630

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

Merged

Conversation

tsullivan
Copy link
Member

@tsullivan tsullivan commented Apr 18, 2025

Summary

Epic: https://github.com/elastic/kibana-team/issues/1435

New Dev Docs for Core Rendering Service
image

@tsullivan tsullivan added release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting labels Apr 18, 2025
@tsullivan tsullivan requested a review from a team April 18, 2025 00:14
@tsullivan tsullivan marked this pull request as ready for review April 21, 2025 21:51
@tsullivan tsullivan requested a review from a team as a code owner April 21, 2025 21:51
Copy link
Contributor

@Dosant Dosant left a comment

Choose a reason for hiding this comment

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

text lgtm, haven't previewed

- `KibanaRootContextProvider` - A root context provider for Kibana. This is the top level context provider that wraps the entire application. It is responsible for initializing all of the other contexts and providing them to the application.
- `KibanaRenderContextProvider` - A render context provider for Kibana. This context is designed to be used with ad-hoc renders of React components, (usually with `ReactDOM.render`).
- `KibanaThemeContextProvider` - A theme context provider for Kibana. A corollary to EUI's `EuiThemeProvider`, it uses Kibana services to ensure the EUI Theme is customized correctly.
- <DocLink id="react/context/root" text="`KibanaRootContextProvider`" /> - A root context provider for Kibana. This is the top level context provider that wraps the entire application. It is responsible for initializing all of the other contexts and providing them to the application.
Copy link
Contributor

Choose a reason for hiding this comment

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

fyi, haven't checked if the links work

Copy link
Contributor

@jloleysens jloleysens left a comment

Choose a reason for hiding this comment

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

Looks good to me! Thanks for adding these dev docs. Left some nit edits.

Bonus nit: would be nice to have a screenshot of the docs in the PR desciption.

Co-authored-by: Anton Dosov <[email protected]>
Co-authored-by: Jean-Louis Leysens <[email protected]>
@tsullivan tsullivan enabled auto-merge (squash) April 23, 2025 00:30
@tsullivan tsullivan merged commit c764851 into elastic:main Apr 23, 2025
10 checks passed
@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

@tsullivan tsullivan deleted the kibana-render-context-provider/refactor-docs branch May 5, 2025 18:26
tsullivan added a commit that referenced this pull request May 6, 2025
A documentation structure update was unintentionally missed in
#218630

This update promotes the Core Rendering Service and offsets the prior
documentation of Kibana React Contexts.

## Summary

<img width="1800" alt="image"
src="https://github.com/%3Ca%20href="https://github.com/user-attachments/assets/9c7634c9-2a1e-43d8-8bb7-850bbf96fc53">https://github.com/user-attachments/assets/9c7634c9-2a1e-43d8-8bb7-850bbf96fc53"
/>
akowalska622 pushed a commit to akowalska622/kibana that referenced this pull request May 29, 2025
## Summary

Epic: elastic/kibana-team#1435

New Dev Docs for Core Rendering Service
<img width="902" alt="image"
src="https://github.com/%3Ca%20href="https://github.com/user-attachments/assets/aa1b8bdb-751d-4ab1-a0e1-8bf62c1c8d96">https://github.com/user-attachments/assets/aa1b8bdb-751d-4ab1-a0e1-8bf62c1c8d96"
/>

---------

Co-authored-by: Anton Dosov <[email protected]>
Co-authored-by: Jean-Louis Leysens <[email protected]>
akowalska622 pushed a commit to akowalska622/kibana that referenced this pull request May 29, 2025
A documentation structure update was unintentionally missed in
elastic#218630

This update promotes the Core Rendering Service and offsets the prior
documentation of Kibana React Contexts.

## Summary

<img width="1800" alt="image"
src="https://github.com/%3Ca%20href="https://github.com/user-attachments/assets/9c7634c9-2a1e-43d8-8bb7-850bbf96fc53">https://github.com/user-attachments/assets/9c7634c9-2a1e-43d8-8bb7-850bbf96fc53"
/>
qn895 pushed a commit to qn895/kibana that referenced this pull request Jun 3, 2025
A documentation structure update was unintentionally missed in
elastic#218630

This update promotes the Core Rendering Service and offsets the prior
documentation of Kibana React Contexts.

## Summary

<img width="1800" alt="image"
src="https://github.com/%3Ca%20href="https://github.com/user-attachments/assets/9c7634c9-2a1e-43d8-8bb7-850bbf96fc53">https://github.com/user-attachments/assets/9c7634c9-2a1e-43d8-8bb7-850bbf96fc53"
/>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting ci:build-next-docs DevDocs release_note:skip Skip the PR/issue when compiling release notes v9.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants