Skip to content

Conversation

@mtojek
Copy link
Contributor

@mtojek mtojek commented Jul 29, 2021

Issue: elastic/integrations#1366

This PR updates elastic-package to escape * { } < > characters while rendering docs.

@mtojek mtojek self-assigned this Jul 29, 2021
@elasticmachine
Copy link
Collaborator

elasticmachine commented Jul 29, 2021

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2021-07-30T10:19:06.761+0000

  • Duration: 25 min 5 sec

  • Commit: de33a5f

Test stats 🧪

Test Results
Failed 0
Passed 316
Skipped 4
Total 320

Trends 🧪

Image of Build Times

Image of Tests

@mtojek mtojek requested a review from jsoriano July 29, 2021 12:06
Copy link
Member

@jsoriano jsoriano left a comment

Choose a reason for hiding this comment

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

👍

Comment on lines 74 to 75
strings.ReplaceAll(c.name, "*", "\\*"),
strings.ReplaceAll(description, "*", "\\*"),
Copy link
Member

Choose a reason for hiding this comment

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

Nit. Consider using a Replacer, so we only need to keep a list of replacements.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed

@mtojek mtojek changed the title Escape wildcard characters in docs Escape special characters in docs Jul 30, 2021
@mtojek mtojek merged commit 7ba6017 into elastic:master Jul 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants