Skip to content

Improve documentation by avoiding redirecting to Metricbeat Metricset #15369

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
Merged
merged 37 commits into from
Oct 13, 2025
Merged

Improve documentation by avoiding redirecting to Metricbeat Metricset #15369

merged 37 commits into from
Oct 13, 2025

Conversation

@herrBez
Copy link
Contributor

@herrBez herrBez commented Sep 17, 2025

Proposed commit message

Improve Custom WMI Input Package documentation

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.
  • I have verified that any added dashboard complies with Kibana's Dashboard good practices

Author's Checklist

  • [ ]

Related issues

Screenshots

@herrBez herrBez requested a review from a team as a code owner September 17, 2025 10:33
@andrewkroh andrewkroh added Integration:wmi Custom WMI Input Package documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. Team:Obs-InfraObs Observability Infrastructure Monitoring team [elastic/obs-infraobs-integrations] labels Sep 17, 2025
stefans-elastic
stefans-elastic reviewed Sep 23, 2025
View reviewed changes
Copy link
Contributor

@stefans-elastic stefans-elastic left a comment

Choose a reason for hiding this comment

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

just a few questions

stefans-elastic
stefans-elastic approved these changes Sep 24, 2025
View reviewed changes
Copy link
Contributor

@stefans-elastic stefans-elastic left a comment

Choose a reason for hiding this comment

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

LGTM

@ishleenk17
Copy link
Member

No changelog required here @herrBez ?

ishleenk17
ishleenk17 approved these changes Sep 25, 2025
View reviewed changes
Copy link
Member

@ishleenk17 ishleenk17 left a comment

Choose a reason for hiding this comment

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

1 comment. README looks good!

@herrBez
Copy link
Contributor Author

herrBez commented Sep 25, 2025

Should I add a changelog entry and bump the version of the integration (?)

@ishleenk17
Copy link
Member

Should I add a changelog entry and bump the version of the integration (?)

YEs we can do that

@herrBez
Copy link
Contributor Author

herrBez commented Sep 25, 2025 •
edited
Loading

Is there any way to have :::note::: like in the integration. I guess if it's rendered here: https://www.elastic.co/docs/reference/integrations it will be shown, but not in Kibana 😕 ...

image

@elastic-sonarqube
Copy link

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube

vishaangelova
vishaangelova reviewed Oct 13, 2025
View reviewed changes
Copy link
Contributor

@vishaangelova vishaangelova left a comment

Choose a reason for hiding this comment

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

Thanks Mirko! I’ve noticed some small issues, so I’ve left some comments for your consideration.

herrBez and others added 9 commits October 13, 2025 20:22
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
cb7113e 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
fd2b257 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
5ceb896 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
98f4a70 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
1c952d9 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
93fd15a 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
3759367 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
e7a3d73 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
3987417 
Co-authored-by: Visha Angelova <[email protected]>
herrBez and others added 21 commits October 13, 2025 20:26
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
5e6b779 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
a0854cf 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
48363d0 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
26382d7 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
c37b78d 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
19e03aa 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
1267544 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
c270b48 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
edd6bb6 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
5fad477 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
4cdacec 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
eca558e 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
b5063d0 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
5267ab4 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
3250e38 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
28fb5c0 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
8c5d3b1 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
f989169 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
0aae280 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez @vishaangelova
Update packages/wmi/docs/README.md
15f71fc 
Co-authored-by: Visha Angelova <[email protected]>
@herrBez
Merge branch 'main' into wmi-doc-improve
2d8288d
@herrBez herrBez requested a review from vishaangelova October 13, 2025 18:35
@elasticmachine
Copy link

💚 Build Succeeded

History

vishaangelova
vishaangelova approved these changes Oct 13, 2025
View reviewed changes
Copy link
Contributor

@vishaangelova vishaangelova left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

@herrBez herrBez merged commit 18270cb into elastic:main Oct 13, 2025
7 checks passed
@elastic-vault-github-plugin-prod
Copy link

Package wmi - 0.0.2 containing this change is available at https://epr.elastic.co/package/wmi/0.0.2/

agithomas pushed a commit to agithomas/integrations that referenced this pull request Oct 30, 2025
@herrBez @vishaangelova @agithomas
Improve documentation by avoiding redirecting to Metricbeat Metricset (…
22f4e7f 
…elastic#15369)

* Improve documentation by avoiding redirecting to Metricbeat Metricset

* Make sure we do not cite Metricbeat and/or metricset

* Bump version after documentation change

* Use warning and note keyword instead of ::::note::::

* Align the documentation with the Metricbeat documentation, makes sure all the properties are documetned

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

* Update packages/wmi/docs/README.md

Co-authored-by: Visha Angelova <[email protected]>

---------

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

Reviewers

@vishaangelova vishaangelova vishaangelova approved these changes

@ishleenk17 ishleenk17 ishleenk17 approved these changes

@stefans-elastic stefans-elastic stefans-elastic approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. Integration:wmi Custom WMI Input Package Team:Obs-InfraObs Observability Infrastructure Monitoring team [elastic/obs-infraobs-integrations]

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@herrBez @ishleenk17 @elasticmachine @vishaangelova @stefans-elastic @andrewkroh