Skip to content

Update docs #2541

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.

Sign up for GitHub

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

Jump to bottom
Closed
bmorelli25 wants to merge 5 commits into from
Closed

Update docs #2541

bmorelli25 wants to merge 5 commits into from

Conversation

@bmorelli25
Copy link
Member

@bmorelli25 bmorelli25 commented Jan 18, 2022 •
edited
Loading

What does this PR do?

This PR fixes the azure_metrics and hashicorp readme files so they work in our documentation. Each of these integrations has {}s that either need to be escaped or enclosed in backticks.

Checklist

  • I have added an entry to my package's changelog.yml file.

Related issues

Temp fix: https://github.com/elastic/wordlake/pull/15
PR where errors were discoverd: https://github.com/elastic/docs.elastic.co/pull/24
@bmorelli25
update hashicorp
85e119d 
# Conflicts: #	packages/hashicorp_vault/changelog.yml
@bmorelli25
update azure docs
7f4ccf2 
# Conflicts: #	packages/azure_metrics/changelog.yml
@bmorelli25 bmorelli25 added the bug Something isn't working, use only for issues label Jan 18, 2022
@bmorelli25 bmorelli25 self-assigned this Jan 18, 2022
bmorelli25
bmorelli25 commented Jan 18, 2022
View reviewed changes
packages/azure_metrics/docs/compute_vm.md
Comment on lines -79 to -86
| azure.compute_vm.\*.\* | compute_vm | object |
| azure.dimensions.\* | Azure metric dimensions. | object |
| azure.metrics.\*.\* | Metrics returned. | object |
| azure.compute_vm.*.* | compute_vm | object |
| azure.dimensions.* | Azure metric dimensions. | object |
| azure.metrics.*.* | Metrics returned. | object |
| azure.namespace | The namespace selected | keyword |
| azure.resource.group | The resource group | keyword |
| azure.resource.id | The id of the resource | keyword |
| azure.resource.name | The name of the resource | keyword |
| azure.resource.tags.\* | Azure resource tags. | object |
Copy link
Member Author

@bmorelli25 bmorelli25 Jan 18, 2022

Choose a reason for hiding this comment

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

So this is a problem. All of the Azure Metrics packages were updated to remove the escaped asterisks in the field docs. This won't break the doc build, but it will bold things in weird places. Can someone help me understand how this happened and what I can do to fix it?
Copy link
Contributor

@efd6 efd6 Feb 1, 2022

Choose a reason for hiding this comment

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

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

elasticmachine commented Jan 18, 2022 •
edited
Loading

💔 Build Failed

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-01-18T22:19:35.785+0000

  • Duration: 9 min 9 sec

  • Commit: 3c26ed1

Steps errors 3

Expand to view the steps failures

Check integration: azure_metrics
  • Took 0 min 1 sec . View more details here
  • Description: ../../build/elastic-package check -v
Check integration: hashicorp_vault
  • Took 0 min 1 sec . View more details here
  • Description: ../../build/elastic-package check -v
Google Storage Download
  • Took 0 min 0 sec . View more details here

🤖 GitHub comments

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

  • /test : Re-trigger the build.
@bmorelli25
Copy link
Member Author

bmorelli25 commented Jan 19, 2022 

[2022-01-18T22:28:29.076Z] README.md is outdated. Rebuild the package with 'elastic-package build'

I'm not sure why it says that the readme is outdated. Running elastic-package build doesn't provide any updates.
@bmorelli25
Copy link
Member Author

bmorelli25 commented Feb 9, 2022 •
edited
Loading

Too out of date to update. Closing and opening new PRs! See:
@bmorelli25 bmorelli25 closed this Feb 9, 2022
@bmorelli25 bmorelli25 deleted the update-docs branch February 9, 2022 00:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working, use only for issues

3 participants

@bmorelli25 @elasticmachine @efd6