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

Consolidate markdown implementation in Kibana #181043

Open
eokoneyo opened this issue Apr 17, 2024 · 1 comment
Open

Consolidate markdown implementation in Kibana #181043

eokoneyo opened this issue Apr 17, 2024 · 1 comment
Assignees
Labels
Team:SharedUX Team label for AppEx-SharedUX (formerly Global Experience)

Comments

@eokoneyo
Copy link
Contributor

eokoneyo commented Apr 17, 2024

Describe the feature:

At the moment, within Kibana there exists multiple markdown implementations across the app; we have the legacy markdown component that leverages the package markdown-it which adheres to the commonmark spec then there's the markdown component provided by the shared UX team which is built on top of the Markdown component provided by EUI team which aims to adhere to the Github flavor markdown spec (referred to from here on as GfM), see elastic/eui#5272 (review).

There are also multiple occurrences of the direct usages of the eui markdown component too across the codebase, all of this unfortunately leads to a lack of coherence with the markdown style across the app especially that the eui markdown component, being built on top of remark (basically a text processor) allows any direct usage of the EUI markdown component the addition of any plugin of choice which could in turn further diversify the markdown styles Kibana supports.

This became very evident, with the attempt to migrate parts of the codebase to the shared UX component, we had reports of in consistencies in rendering expectations. See #180576

Proposal;

  • Adopt the GfM markdown flavour within Kibana, and exclusively support only this flavour.
  • On deciding what the flavour to adopt (GfM), the shared UX team will provide a component that supports this decided on implementation provided for adoption (leveraging the Markdown component provided by the EUI team), with tests put in place to validate how markdown renders happen so that any future change to this is caught something along the lines of Reference for markdown implementation in kibana #180926 should be sufficient.
  • All parts of kibana will be migrated to the aforementioned component, guard rails should also be put in place to enforce that only this implementation is what is used across the app.
@eokoneyo eokoneyo added the Team:SharedUX Team label for AppEx-SharedUX (formerly Global Experience) label Apr 17, 2024
@eokoneyo eokoneyo self-assigned this Apr 17, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/appex-sharedux (Team:SharedUX)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:SharedUX Team label for AppEx-SharedUX (formerly Global Experience)
Projects
None yet
Development

No branches or pull requests

2 participants