Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 3 commits into from
Sep 27, 2022

Conversation

colleenmcginnis
Copy link
Contributor

@colleenmcginnis colleenmcginnis commented Sep 23, 2022

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 Team:Docs Label for the Observability docs team docs labels Sep 23, 2022
@elasticmachine
Copy link

elasticmachine commented Sep 23, 2022

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

@elasticmachine
Copy link

elasticmachine commented Sep 23, 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-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
Copy link

elasticmachine commented Sep 23, 2022

🌐 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) 💚

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 conflicts and PR link and are resolved.

packages/ti_cif3/changelog.yml Outdated Show resolved Hide resolved
colleenmcginnis and others added 2 commits September 26, 2022 20:41
Co-authored-by: Dan Kortschak <90160302+efd6@users.noreply.github.com>
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. Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs documentation Improvements or additions to documentation 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.

None yet

3 participants