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

[APM] Agent configuration - EuiMarkdownFormat when rendering setting description #141086

Merged

Conversation

yngrdyn
Copy link
Contributor

@yngrdyn yngrdyn commented Sep 20, 2022

closes 61285

  • Used EuiMarkdownFormat component to render setting description.

Before this change
image

After this change
image

@yngrdyn yngrdyn added release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting labels Sep 20, 2022
@yngrdyn yngrdyn requested a review from a team as a code owner September 20, 2022 13:48
@botelastic botelastic bot added the Team:APM All issues that need APM UI Team support label Sep 20, 2022
@elasticmachine
Copy link
Contributor

Pinging @elastic/apm-ui (Team:APM)

Copy link
Contributor

@kpatticha kpatticha left a comment

Choose a reason for hiding this comment

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

thanks for fixing it. LGTM I just a comment

@@ -163,7 +164,7 @@ export function SettingFormRow({
}
description={
<>
{setting.description}
<ReactMarkdown>{setting.description}</ReactMarkdown>
Copy link
Contributor

@kpatticha kpatticha Sep 20, 2022

Choose a reason for hiding this comment

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

FYI: Eui has a formatter that renders the markdown and it seems to be used

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ohhh! I liked that one better.
image

should we use that one instead?

Copy link
Contributor

Choose a reason for hiding this comment

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

it looks nice 🤩 !

EuiMarkdownFormat is labeled as beta but it was released on 28.0.0 - more than 2 years ago, so I think we won't have any issue.

Copy link
Contributor

Choose a reason for hiding this comment

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

@yngrdyn yngrdyn force-pushed the agent_remote_configuration_inline_code_examples branch from b5c0a7a to 0faffbe Compare September 20, 2022 14:22
@yngrdyn yngrdyn changed the title [APM] Agent configuration - ReactMarkdown when rendering setting description [APM] Agent configuration - EuiMarkdownFormat when rendering setting description Sep 20, 2022
@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
apm 3.1MB 3.1MB +44.0B

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@yngrdyn yngrdyn merged commit 45649ce into elastic:main Sep 20, 2022
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 release_note:skip Skip the PR/issue when compiling release notes Team:APM All issues that need APM UI Team support v8.5.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[APM] Agent remote configuration: Show inline code examples as EuiText <code>
5 participants