prometheus / prometheus/exporter-toolkit

Clarify "This repository is currently WIP and experimental."

Open
#45 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
311
Forks
109
Avg merge
3d 59m
Merged PRs (30d)
6

Description

We should be more granular about this phrasing.

It is experimental because we migth need to change some security settings to stay secure.

It is WIP because a large part of the toolkit is yet to be written, e.g. the landing page.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Search the repository for the sentence "This repository is currently WIP and experimental." and inspect the surrounding documentation. Revise the wording to distinguish the security-related experimental status from the unfinished toolkit, including the missing landing page. Done means the statement is more granular and accurately reflects both reasons.

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
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.