-
Notifications
You must be signed in to change notification settings - Fork 442
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
[docs] Escape left angle bracket (<
)
#4369
[docs] Escape left angle bracket (<
)
#4369
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM after nit.
🚀 Benchmarks reportTo see the full report comment with |
🌐 Coverage report
|
@@ -27,7 +25,7 @@ This module has been tested against `Infoblox BloxOne DDI API (v1)`. | |||
### To collect data from Infoblox BloxOne DDI APIs, the user must have API Key. To create an API key follow the below steps: | |||
|
|||
1. Log on to the Cloud Services Portal. | |||
2. Go to **<User_Name> -> User Profile**. | |||
2. Go to **\<User_Name> -> User Profile**. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@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.
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.yml
file.Screenshots