Default Remote Write Endpoint is Difficult to Find
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 717
- Forks
- 1.2k
- Avg merge
- 3d 15h
- Merged PRs (30d)
- 19
Description
There is documentation of config vars, a series of blog posts and a page dedicated to aspects of the functionality. However, the actual default endpoint of "/api/v1/write" is in a glossary item or something similar. I'm happy to make a PR, but not sure where this should be, but it and its configurability should be more prominent.
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 existing config-variable documentation, related blog posts, functionality page, and the glossary item containing "/api/v1/write". Decide where the default endpoint and its configurability are most discoverable, then update the relevant documentation and verify that the endpoint and configuration guidance are prominent and consistent.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100