beats icon indicating copy to clipboard operation
beats copied to clipboard

[docs][filebeat] convert remaining docs to markdown

Open VihasMakwana opened this issue 6 months ago • 10 comments

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.asciidoc or CHANGELOG-developer.next.asciidoc.

How to test this PR

Related issues

  • Relates https://github.com/elastic/beats/issues/43008

VihasMakwana avatar Jun 17 '25 09:06 VihasMakwana

:robot: GitHub comments

Expand to view the GitHub comments

Just comment with:

  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

github-actions[bot] avatar Jun 17 '25 09:06 github-actions[bot]

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./d is the label to automatically backport to the 8./d branch. /d is the digit
  • backport-active-all is the label that automatically backports to all active branches.
  • backport-active-8 is the label that automatically backports to all active minor branches for the 8 major.
  • backport-active-9 is the label that automatically backports to all active minor branches for the 9 major.

mergify[bot] avatar Jun 17 '25 09:06 mergify[bot]

Pinging @elastic/elastic-agent-data-plane (Team:Elastic-Agent-Data-Plane)

elasticmachine avatar Jun 17 '25 09:06 elasticmachine

@VihasMakwana hello, can I run docs preview locally?

mykola-elastic avatar Jun 18 '25 08:06 mykola-elastic

@mykola-elastic you can see docs changes in the PR preview or build the docs locally using docs-builder.

colleenmcginnis avatar Jun 18 '25 18:06 colleenmcginnis

@VihasMakwana hello, can I run docs preview locally?

As Colleen mentioned, You'll need to install docs-builder to test it out.

  1. Install docs-builder by following this.
  2. cd into beats and checkout this PR locally
  3. run docs-builder serve
  4. View the documentation at localhost:3000

VihasMakwana avatar Jun 19 '25 05:06 VihasMakwana

Pinging @elastic/obs-ds-hosted-services (Team:obs-ds-hosted-services)

elasticmachine avatar Jun 20 '25 07:06 elasticmachine

Pinging @elastic/sec-windows-platform (Team:Security-Windows Platform)

elasticmachine avatar Jun 20 '25 07:06 elasticmachine

Pinging @elastic/sec-linux-platform (Team:Security-Linux Platform)

elasticmachine avatar Jun 20 '25 07:06 elasticmachine

Pinging @elastic/sec-deployment-and-devices (Team:Security-Deployment and Devices)

elasticmachine avatar Jun 20 '25 07:06 elasticmachine

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

mergify[bot] avatar Jun 26 '25 06:06 mergify[bot]

🔍 Preview links for changed docs

More links …

github-actions[bot] avatar Jul 03 '25 06:07 github-actions[bot]

@consulthys I've updated the titles in this PR and the casing should now be correct. Screenshot 2025-07-03 at 12 09 15 PM

VihasMakwana avatar Jul 03 '25 06:07 VihasMakwana