beats
beats copied to clipboard
[docs][metricbeat] - remove asciidoc and add markdown
Proposed commit message
This is a follow-up of https://github.com/elastic/beats/pull/44638.
This PR converts metricbeat docs to markdown and resolves a TODO. Most changes are related to asciidoc and metricbeat/scripts/docs_collector.go is responsible for generating it.
Checklist
- [x] My code follows the style guidelines of this project
- [x] I have commented my code, particularly in hard-to-understand areas
- [x] I have made corresponding changes to the documentation
- [ ] I have made corresponding change to the default configuration files
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have added an entry in
CHANGELOG.next.asciidocorCHANGELOG-developer.next.asciidoc.
How to test this PR
- Head to docs-preview and verify the metricbeat docs
Related issues
- Relates https://github.com/elastic/beats/issues/43008
:robot: GitHub comments
Expand to view the GitHub comments
Just comment with:
rundocs-build: Re-trigger the docs validation. (use unformatted text in the comment!)
This pull request does not have a backport label. If this is a bug or security fix, could you label this PR @VihasMakwana? 🙏. For such, you'll need to label your PR with:
- The upcoming major version of the Elastic Stack
- The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)
To fixup this pull request, you need to add the backport labels for the needed branches, such as:
backport-8./dis the label to automatically backport to the8./dbranch./dis the digitbackport-active-allis the label that automatically backports to all active branches.backport-active-8is the label that automatically backports to all active minor branches for the 8 major.backport-active-9is the label that automatically backports to all active minor branches for the 9 major.
Pinging @elastic/obs-ds-hosted-services (Team:obs-ds-hosted-services)
Pinging @elastic/elastic-agent-data-plane (Team:Elastic-Agent-Data-Plane)
This pull request is now in conflicts. Could you fix it? 🙏 To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/
git fetch upstream
git checkout -b metricbeat-docs upstream/metricbeat-docs
git merge upstream/main
git push upstream metricbeat-docs
@colleenmcginnis thanks for you review!! I'll take a look the files and get back to you.
@colleenmcginnis Here's my thoughts after going through the files again:
docs/reference/metricbeat/metricbeat-metricset-kubernetes-state_horizontalpodautoscaler.md- This module was recently added, but the documentation was missed in the original PR.
- Now, it is added automatically due to script.
docs/reference/metricbeat/metricbeat-metricset-windows-wmi.mddocs/reference/metricbeat/metricbeat-metricset-mysql-galera_status.md- For some reason, both of the above files were missing the
## Fields [_fields]section. That section is dynamically inserted from each module. - The changes are expected for them.
- For some reason, both of the above files were missing the
docs/reference/metricbeat/metricbeat-module-gcp.md- The
dataprocmetricset was recently added to the module configuration. But, the documentation wasn't updated. https://github.com/elastic/beats/pull/43518/files
- The
docs/reference/metricbeat/metricbeat-module-sql.mddocs/reference/metricbeat/metricbeat-module-statsd.md- For some reason, both of the above filere were missing an
## Example Conifgurationand**## Metricsets**sections. Now, they're added automatically due to the script.
- For some reason, both of the above filere were missing an
docs/reference/metricbeat/metricbeat-metricset-nats-jetstream.md- I've fixed this file. The main doc wasn't updated and as a result, changes weren't reflected in autogenerated doc. It was missing
## Fields [_fields]section previously. I've added that as well.
- I've fixed this file. The main doc wasn't updated and as a result, changes weren't reflected in autogenerated doc. It was missing
This pull request is now in conflicts. Could you fix it? 🙏 To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/
git fetch upstream
git checkout -b metricbeat-docs upstream/metricbeat-docs
git merge upstream/main
git push upstream metricbeat-docs
@VihasMakwana We merged https://github.com/elastic/beats/pull/44579 in the meantime and it caused conflicts, can you look into it and regenerate the markdown doc? Thank you.
@zmoog Thanks for pointing this out! There was a typo introduced. I guess it was due to resolving merge conflicts.
https://docs-v3-preview.elastic.dev/elastic/beats/pull/44947/reference/metricbeat/metricbeat-metricset-aws-dynamodb and other metricsets now show correct docs.
@VihasMakwana Shouldn't this PR be backported to the 9.1 branch as well?
@vishaangelova Yes, it should be. I've added the label.