Skip to content

Conversation

@VihasMakwana
Copy link
Contributor

@VihasMakwana VihasMakwana commented Jun 12, 2025

Proposed commit message

This is a follow-up of #44638.
This PR takes care of autogeneration of exported-fields.md document for each beat.

Unfortunately, it is not possible to break down this into PR for each beat because this particular autogeneration script is shared by each beat and is under libbeat. Updating dev-tools/mage/docs.go and libbeat/scripts/generate_fields_docs.py will update generate exported-fields for each beat.

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • 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

  • Head to docs-preview and verify the docs the Exported Fields section for each beat.

Related issues

@VihasMakwana VihasMakwana self-assigned this Jun 12, 2025
@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Jun 12, 2025
@VihasMakwana VihasMakwana changed the title [documentation][exported-fields] fix autogeneration scripts to generate markdown [documentation][exported-fields] update autogeneration scripts to generate markdown Jun 12, 2025
@github-actions
Copy link
Contributor

🤖 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!)

@mergify
Copy link
Contributor

mergify bot commented Jun 12, 2025

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.

@VihasMakwana VihasMakwana added the Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team label Jun 12, 2025
@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Jun 12, 2025
@VihasMakwana VihasMakwana marked this pull request as ready for review June 12, 2025 16:53
@VihasMakwana VihasMakwana requested review from a team as code owners June 12, 2025 16:53
@elasticmachine
Copy link
Collaborator

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

@VihasMakwana VihasMakwana force-pushed the exported-fields-autogeneration branch from 5d7e3e1 to febf3fa Compare June 12, 2025 16:55
@VihasMakwana VihasMakwana requested review from AndersonQ and mauri870 and removed request for andrzej-stencel and khushijain21 June 12, 2025 16:55
@VihasMakwana
Copy link
Contributor Author

VihasMakwana commented Jun 12, 2025

Adding @AndersonQ and @mauri870 as reviewers, as they reviewed the first PR.

@VihasMakwana VihasMakwana requested a review from a team as a code owner June 12, 2025 17:03
@VihasMakwana VihasMakwana force-pushed the exported-fields-autogeneration branch from e4af4a5 to bc9ce19 Compare June 12, 2025 17:08
@VihasMakwana VihasMakwana removed the request for review from a team June 12, 2025 17:09
Copy link
Contributor

@colleenmcginnis colleenmcginnis left a comment

Choose a reason for hiding this comment

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

I browsed through the Markdown files. I took a couple notes on some formatting we might be able to improve in the descriptions in the source YAML files later, but there's nothing blocking. Thanks again for your work on this!

@VihasMakwana VihasMakwana requested a review from pazone June 13, 2025 06:20
Copy link
Member

@AndersonQ AndersonQ left a comment

Choose a reason for hiding this comment

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

I checked a few exported fields page for every beat, they're there so it looks good!

@VihasMakwana VihasMakwana merged commit 00dcc0c into elastic:main Jun 13, 2025
201 of 204 checks passed
@VihasMakwana VihasMakwana added the backport-9.0 Automated backport to the 9.0 branch label Jun 13, 2025
mergify bot pushed a commit that referenced this pull request Jun 13, 2025
…erate markdown (#44793)

* chore: port asciidoc scripts to markdown

* fix docs preview

* add meraki description

* make check

(cherry picked from commit 00dcc0c)

# Conflicts:
#	docs/reference/metricbeat/exported-fields-nats.md
#	libbeat/scripts/generate_fields_docs.py
VihasMakwana added a commit that referenced this pull request Jun 17, 2025
…neration scripts to generate markdown (#44803)

* [documentation][exported-fields] update autogeneration scripts to generate markdown  (#44793)

* chore: port asciidoc scripts to markdown

* fix docs preview

* add meraki description

* make check

(cherry picked from commit 00dcc0c)

# Conflicts:
#	docs/reference/metricbeat/exported-fields-nats.md
#	libbeat/scripts/generate_fields_docs.py

* merge conflicts

* exported docs

---------

Co-authored-by: Vihas Makwana <[email protected]>
Co-authored-by: Vihas Makwana <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport-9.0 Automated backport to the 9.0 branch docs enhancement Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants