Skip to content
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

Merged
merged 3 commits into from
Oct 3, 2022

Conversation

colleenmcginnis
Copy link
Contributor

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:

Unescaped left angle bracket / less than (<) and left curly brace ({) have to be escaped: \< or \{ (or use expressions: {'<'}, {'{'})

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

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.

Screenshots

Screen Shot 2022-10-03 at 4 39 49 PM

@colleenmcginnis colleenmcginnis added the enhancement New feature or request label Oct 3, 2022
@colleenmcginnis colleenmcginnis self-assigned this Oct 3, 2022
@colleenmcginnis colleenmcginnis requested a review from a team as a code owner October 3, 2022 21:43
@colleenmcginnis colleenmcginnis added documentation Improvements or additions to documentation docs labels Oct 3, 2022
Copy link
Contributor

@efd6 efd6 left a comment

Choose a reason for hiding this comment

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

LGTM after nit.

@colleenmcginnis colleenmcginnis added bug Something isn't working, use only for issues and removed enhancement New feature or request labels Oct 3, 2022
@colleenmcginnis colleenmcginnis requested a review from efd6 October 3, 2022 21:52
@elasticmachine
Copy link

elasticmachine commented Oct 3, 2022

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

@elasticmachine
Copy link

elasticmachine commented Oct 3, 2022

💚 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: 2022-10-03T21:52:35.809+0000

  • Duration: 17 min 21 sec

Test stats 🧪

Test Results
Failed 0
Passed 19
Skipped 0
Total 19

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

@elasticmachine
Copy link

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (3/3) 💚
Files 100.0% (3/3) 💚 2.569
Classes 100.0% (3/3) 💚 2.569
Methods 100.0% (39/39) 💚 9.972
Lines 98.278% (2568/2613) 👍 6.755
Conditionals 100.0% (0/0) 💚

@@ -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**.
Copy link
Member

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.

https://github.com/elastic/wordlake/blob/main/utils/integrations-exporter/content/content.go#L38

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
bug Something isn't working, use only for issues docs documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants