[docs][filebeat] convert remaining docs to markdown
Proposed commit message
This is a follow-up of https://github.com/elastic/beats/pull/44638.
This PR converts filebeat docs to markdown and resolves a TODO. Most changes are related to asciidoc and filebeat/scripts/docs_collector.py 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 auditbeat 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 digit -
backport-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/elastic-agent-data-plane (Team:Elastic-Agent-Data-Plane)
@VihasMakwana hello, can I run docs preview locally?
@mykola-elastic you can see docs changes in the PR preview or build the docs locally using docs-builder.
@VihasMakwana hello, can I run docs preview locally?
As Colleen mentioned, You'll need to install docs-builder to test it out.
- Install docs-builder by following this.
- cd into beats and checkout this PR locally
- run
docs-builder serve - View the documentation at localhost:3000
Pinging @elastic/obs-ds-hosted-services (Team:obs-ds-hosted-services)
Pinging @elastic/sec-windows-platform (Team:Security-Windows Platform)
Pinging @elastic/sec-linux-platform (Team:Security-Linux Platform)
Pinging @elastic/sec-deployment-and-devices (Team:Security-Deployment and Devices)
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 filebeat-docs-markdown upstream/filebeat-docs-markdown
git merge upstream/main
git push upstream filebeat-docs-markdown
🔍 Preview links for changed docs
- docs/reference/filebeat/exported-fields-checkpoint.md
- docs/reference/filebeat/exported-fields-coredns.md
- docs/reference/filebeat/exported-fields-crowdstrike.md
- docs/reference/filebeat/exported-fields-cyberarkpas.md
- docs/reference/filebeat/exported-fields-google_workspace.md
- docs/reference/filebeat/exported-fields-ibmmq.md
- docs/reference/filebeat/exported-fields-iptables.md
- docs/reference/filebeat/exported-fields-kibana.md
- docs/reference/filebeat/exported-fields-logstash.md
- docs/reference/filebeat/exported-fields-mongodb.md
More links …
- docs/reference/filebeat/exported-fields-mssql.md
- docs/reference/filebeat/exported-fields-panw.md
- docs/reference/filebeat/exported-fields-sophos.md
- docs/reference/filebeat/exported-fields-threatintel.md
- docs/reference/filebeat/exported-fields-zeek.md
- docs/reference/filebeat/exported-fields.md
- docs/reference/filebeat/filebeat-module-activemq.md
- docs/reference/filebeat/filebeat-module-apache.md
- docs/reference/filebeat/filebeat-module-auditd.md
- docs/reference/filebeat/filebeat-module-aws.md
- docs/reference/filebeat/filebeat-module-awsfargate.md
- docs/reference/filebeat/filebeat-module-azure.md
- docs/reference/filebeat/filebeat-module-cef.md
- docs/reference/filebeat/filebeat-module-checkpoint.md
- docs/reference/filebeat/filebeat-module-cisco.md
- docs/reference/filebeat/filebeat-module-coredns.md
- docs/reference/filebeat/filebeat-module-crowdstrike.md
- docs/reference/filebeat/filebeat-module-cyberarkpas.md
- docs/reference/filebeat/filebeat-module-elasticsearch.md
- docs/reference/filebeat/filebeat-module-envoyproxy.md
- docs/reference/filebeat/filebeat-module-fortinet.md
- docs/reference/filebeat/filebeat-module-gcp.md
- docs/reference/filebeat/filebeat-module-google_workspace.md
- docs/reference/filebeat/filebeat-module-haproxy.md
- docs/reference/filebeat/filebeat-module-ibmmq.md
- docs/reference/filebeat/filebeat-module-icinga.md
- docs/reference/filebeat/filebeat-module-iis.md
- docs/reference/filebeat/filebeat-module-iptables.md
- docs/reference/filebeat/filebeat-module-juniper.md
- docs/reference/filebeat/filebeat-module-kafka.md
- docs/reference/filebeat/filebeat-module-kibana.md
- docs/reference/filebeat/filebeat-module-logstash.md
- docs/reference/filebeat/filebeat-module-microsoft.md
- docs/reference/filebeat/filebeat-module-misp.md
- docs/reference/filebeat/filebeat-module-mongodb.md
- docs/reference/filebeat/filebeat-module-mssql.md
- docs/reference/filebeat/filebeat-module-mysql.md
- docs/reference/filebeat/filebeat-module-mysqlenterprise.md
- docs/reference/filebeat/filebeat-module-nats.md
- docs/reference/filebeat/filebeat-module-netflow.md
- docs/reference/filebeat/filebeat-module-nginx.md
- docs/reference/filebeat/filebeat-module-o365.md
- docs/reference/filebeat/filebeat-module-okta.md
- docs/reference/filebeat/filebeat-module-oracle.md
- docs/reference/filebeat/filebeat-module-osquery.md
- docs/reference/filebeat/filebeat-module-panw.md
- docs/reference/filebeat/filebeat-module-pensando.md
- docs/reference/filebeat/filebeat-module-postgresql.md
- docs/reference/filebeat/filebeat-module-rabbitmq.md
- docs/reference/filebeat/filebeat-module-redis.md
- docs/reference/filebeat/filebeat-module-salesforce.md
- docs/reference/filebeat/filebeat-module-santa.md
- docs/reference/filebeat/filebeat-module-snyk.md
- docs/reference/filebeat/filebeat-module-sophos.md
- docs/reference/filebeat/filebeat-module-suricata.md
- docs/reference/filebeat/filebeat-module-system.md
- docs/reference/filebeat/filebeat-module-threatintel.md
- docs/reference/filebeat/filebeat-module-traefik.md
- docs/reference/filebeat/filebeat-module-zeek.md
- docs/reference/filebeat/filebeat-module-zookeeper.md
- docs/reference/filebeat/filebeat-module-zoom.md
- docs/reference/filebeat/filebeat-modules.md
@consulthys I've updated the titles in this PR and the casing should now be correct.