[docs] Escape left angle bracket (<)#4369
Merged
colleenmcginnis merged 3 commits intoOct 3, 2022
Merged
Conversation
colleenmcginnis
commented
Oct 3, 2022
colleenmcginnis
added
documentation
colleenmcginnis
added
bug
efd6
approved these changes
Oct 3, 2022
🚀 Benchmarks reportTo see the full report comment with |
💚 Build Succeeded
Expand to view the summary
Build stats
Test stats 🧪
🤖 GitHub commentsExpand to view the GitHub comments
To re-run your PR in the CI, just comment with:
|
🌐 Coverage report
|
bmorelli25
reviewed
Oct 4, 2022
|
|
||
| 1. Log on to the Cloud Services Portal. | ||
| 2. Go to **<User_Name> -> User Profile**. | ||
| 2. Go to **\<User_Name> -> User Profile**. |
Member
There was a problem hiding this comment.
@colleenmcginnis FYI we need to be careful with arrows. This one is fine, but if it had two dashes (-->) it would be considered an HTML comment and replaced.
https://github.com/elastic/wordlake/blob/main/utils/integrations-exporter/content/content.go#L38
orestisfl
pushed a commit
to orestisfl/integrations
that referenced
this pull request
May 15, 2026
* escape left angle bracket * add pr link * label as bugfix
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related: #4295
What does this PR do?
Escapes the left angle bracket (
<) used in the new Infoblox BloxOne DDI doc.The Integration docs use MDX (not plain Markdown). From the MDX documentation:
I used
\<because it also renders correctly in plain Markdown (see Screenshots below).Note: This PR also removes the "Overview" heading, which will be added when the file is processed from a Markdown file to an MDX file. Though including the "Overview" heading here doesn't break the build, it does result in two "Overview" headings on the page for this integration on docs.elastic.co.
Checklist
changelog.ymlfile.Screenshots