Skip to content

Fix azure_metrics docs - #2656

Merged
bmorelli25 merged 2 commits into
elastic:mainfrom
bmorelli25:fix-azure-metrics
Feb 11, 2022
Merged

Fix azure_metrics docs#2656
bmorelli25 merged 2 commits into
elastic:mainfrom
bmorelli25:fix-azure-metrics

Conversation

@bmorelli25

@bmorelli25 bmorelli25 commented Feb 9, 2022

Copy link
Copy Markdown
Member

Summary

The Azure Metrics readmes are breaking the integration documentation update script. This PR fixes the error by moving a string including { and } to a code snippet.

Related

Other PRs that I have opened with similar problems:

@bmorelli25 bmorelli25 added the Team:Docs Label for the Observability docs team label Feb 9, 2022
@bmorelli25
bmorelli25 requested a review from efd6 February 9, 2022 00:32
@bmorelli25 bmorelli25 self-assigned this Feb 9, 2022
@bmorelli25 bmorelli25 mentioned this pull request Feb 9, 2022
1 task
@bmorelli25

Copy link
Copy Markdown
Member Author

@efd6 commented:

@bmorelli25 What version of elastic-package are you using? The escaping of md-meaningful characters was added in July last year, so if you're using an older version than that, you would expect to see this happen. This would also explain the error you see below; the new version used in CI will produce the correct output which would differ from what is here.

Thanks, Dan! You're right, I was using an out of date elastic-package. As for the escaping of md-meaningful chars, as I understand, that only applies to fields that are built into the readmes. It doesn't apply to raw text in the _dev/build/docs/readme.md files.

Comment thread packages/azure_metrics/changelog.yml Outdated
@elasticmachine

elasticmachine commented Feb 9, 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-02-09T00:49:30.670+0000

  • Duration: 20 min 7 sec

Test stats 🧪

Test Results
Failed 0
Passed 131
Skipped 0
Total 131

🤖 GitHub comments

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

  • /test : Re-trigger the build.
@bmorelli25
bmorelli25 merged commit 48b9cf4 into elastic:main Feb 11, 2022
@bmorelli25
bmorelli25 deleted the fix-azure-metrics branch February 11, 2022 18:43
orestisfl pushed a commit to orestisfl/integrations that referenced this pull request May 15, 2026
* update azure_metrics docs

* Update packages/azure_metrics/changelog.yml
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Team:Docs Label for the Observability docs team

3 participants