Repository navigation
docs: make the README say whose project this is - #27
Merged
Merged
Conversation
The badges reported upstream's CI, Go report, SonarCloud and Docker Hub pulls, so our README asserted the state of a repository this is not, for services we do not even use. Someone landing here could not tell what they were looking at, and the install instructions sent them to an image we do not publish. Badges now point at this repository and cover only what actually runs here. The fork notice moves above the description and states the support position plainly: maintained for HTB's needs, use at your own risk, PRs welcome, no support promised. Adds a Differences from upstream section, since that is the only honest reason to run this instead of the original, with the upstream issues each fix corresponds to. docker pull and git clone now reference ghcr.io and this repository. Links to upstream issues and the contributor credits stay pointed at upstream, because that is where those live.
Adds the three Hack The Box contributors whose work only exists in this fork: Christina Moraiti (Kubernetes client, pod discovery, list and watch), Vasilis Vlasopoulos (the phpfpm_pod metric label) and Dimosthenis Schizas (CI, release pipeline, toolchain, docs and the bug fixes). Roles taken from the commit history, not guessed. The eleven existing entries keep their links pointing at hipages, where that work originated. The new three point here, because that is the only place their commits exist. .all-contributorsrc projectOwner becomes hackthebox, since that is what this repository is; regenerating the list would otherwise attribute HTB commits to upstream. Says plainly above the table that most of this exporter predates the fork. The badge count was stale at 4 against eleven entries and is now 14.
Running the all-contributors CLI would silently repoint all eleven inherited contributors at this fork. That may be right eventually, but relocating other people's attribution should be a decision rather than a side effect of a generator, so the reasoning is written down next to the constraint that forces projectOwner to be hackthebox.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The README opened with nine badges, every one of them reporting upstream's repository:
workflows/Test/badge.svgfrom hipages, not our CIgithub.com/hipages/php-fpm_exporterSo the page asserted the state of a repository this is not, partly for services we do not use. The install instructions then sent readers to
docker pull hipages/php-fpm_exporterandgit clone hipages/....There was a fork note, but it sat below the badges and apologised for them ("Some badges above still reference the upstream repository") rather than fixing them.
Changes
Badges now point here and cover only what actually runs: the Test workflow, Go Report Card, pkg.go.dev, and the local all-contributors count. The rest are removed rather than repointed, because we do not run SonarCloud, publish to Docker Hub, or want a vanity star chart.
The fork notice moves above the description and states the position plainly:
It also records that upstream's last release was v2.2.0 in May 2022, and that images are GHCR-only.
A new
Differences from upstreamsection, because that is the only honest reason to run this instead of the original. It groups the fixes into crashes and hangs, metrics correctness, CLI behaviour and additions, and links each to the upstream issue it corresponds to where one exists (#253, #322, #419).docker pullandgit clonereferenceghcr.io/hackthebox/php-fpm_exporterand this repository.Deliberately left pointing upstream
commits?author=links point at hipages where that work originated. The original authors keep their attribution.Contributors
Adds the three Hack The Box contributors whose work exists only in this fork, with roles taken from the commit history: Christina Moraiti (Kubernetes client, pod discovery, list and watch), Vasilis Vlasopoulos (the
phpfpm_podmetric label) and Dimosthenis Schizas (CI, release pipeline, toolchain, docs, bug fixes). Their links point here, because this is the only place those commits exist..all-contributorsrcprojectOwnerbecomeshackthebox, since regenerating the list would otherwise attribute HTB commits to upstream. The badge count was stale at 4 against eleven entries and is now 14.The section now says plainly above the table that most of this exporter predates the fork and that it stands on that work.
Verification
Every internal anchor in the document resolves, checked by generating the heading slugs and diffing them against the links. The emptied "Stargazers over time" heading and its table-of-contents entry are removed.
Nothing outside README.md changes.