Include exporter documentation in the website
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 717
- Forks
- 1.2k
- Avg merge
- 3d 15h
- Merged PRs (30d)
- 19
Description
We see tons of questions on Kapa.ai about how to monitor certain software/hardware, and Kapa doesn't answer them even though we have exporters for it. One way of solving the problem is to include Exporter documentation on the website. While it helps folks using our AI integration to answer questions, it also helps regular users who read pages on the website.
The Prometheus Exporter Working Group is currently working on standardizing end-user documentation, so it's a good time to start thinking about how to bring exporter docs to the website in a standardized way as well.
I've created a PoC (totally AI-driven) at https://github.com/prometheus/docs/pull/3076, but it would be awesome to properly discuss this with other folks who are activelly maintaining docs
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the exporter documentation standardization work described in the issue and the proof of concept in prometheus/docs#3076. Discuss the approach with the documentation maintainers and exporter working group; done means an agreed, standardized way to include exporter documentation on the website.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100