Skip to content

[docs] Escape less than symbol (<)#4295

Merged
colleenmcginnis merged 3 commits into
elastic:mainfrom
colleenmcginnis:fix-doc-build
Sep 27, 2022
Merged

[docs] Escape less than symbol (<)#4295
colleenmcginnis merged 3 commits into
elastic:mainfrom
colleenmcginnis:fix-doc-build

Conversation

@colleenmcginnis

@colleenmcginnis colleenmcginnis commented Sep 23, 2022

Copy link
Copy Markdown
Contributor

What does this PR do?

Escapes the less than symbol (<) used in the new Collective Intelligence Framework v3 Integration docs.

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).

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

image

@colleenmcginnis colleenmcginnis requested a review from a team as a code owner September 23, 2022 18:41
@colleenmcginnis colleenmcginnis self-assigned this Sep 23, 2022
@colleenmcginnis colleenmcginnis added enhancement New feature or request documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. Team:Docs Label for the Observability docs team docs labels Sep 23, 2022
@elasticmachine

elasticmachine commented Sep 23, 2022

Copy link
Copy Markdown

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

@elasticmachine

elasticmachine commented Sep 23, 2022

Copy link
Copy Markdown

💚 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-09-27T01:43:17.247+0000

  • Duration: 14 min 14 sec

Test stats 🧪

Test Results
Failed 0
Passed 11
Skipped 0
Total 11

🤖 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

elasticmachine commented Sep 23, 2022

Copy link
Copy Markdown

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (1/1) 💚
Files 100.0% (1/1) 💚 2.582
Classes 100.0% (1/1) 💚 2.582
Methods 85.714% (12/14) 👎 -4.224
Lines 39.615% (103/260) 👎 -51.749
Conditionals 100.0% (0/0) 💚

@efd6 efd6 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM after conflicts and PR link and are resolved.

Comment thread packages/ti_cif3/changelog.yml Outdated
Colleen McGinnis and others added 2 commits September 26, 2022 20:41
Co-authored-by: Dan Kortschak <90160302+efd6@users.noreply.github.com>

@efd6 efd6 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM. Thanks

@colleenmcginnis colleenmcginnis merged commit 7231889 into elastic:main Sep 27, 2022
@colleenmcginnis colleenmcginnis deleted the fix-doc-build branch September 27, 2022 14:17
orestisfl pushed a commit to orestisfl/integrations that referenced this pull request May 15, 2026
* escape less than symbol

* add pr link

Co-authored-by: Dan Kortschak <90160302+efd6@users.noreply.github.com>

Co-authored-by: Dan Kortschak <90160302+efd6@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. enhancement New feature or request Team:Docs Label for the Observability docs team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants