Remove badges from documentation#162
Merged
Merged
Conversation
The badges are given a prominent position at the top of the user documentation but are of very little value to the user. Those who want to know the current release can see it very clearly on the plugins site https://plugins.jenkins.io/plot/releases/ and on the GitHub page https://github.com/jenkinsci/plot-plugin/releases . The coverage information from the codecov badge is available from the coverage report on ci.jenkins.io and from the coverage check report on GitHub. One more location for coverage reporting is not valuable enough to occupy the top line of the user documentation. The installation count is provided on the plugins.jenkins.io page and includes a 12 month history graph and easy access to detailed deployment statistics by plugin version and Jenkins core version.
gounthar
approved these changes
Jan 6, 2025
gounthar
left a comment
gounthar
left a comment
Contributor
There was a problem hiding this comment.
That's a very valid point, thanks, Mark! 👍
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
2 participants
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.
Remove badges from documentation
The badges are given a prominent position at the top of the user documentation but are of very little value to the user. Those who want to know the current release can see it very clearly on the plugins site and on the GitHub page.
The coverage information from the codecov badge is available from the coverage report on ci.jenkins.io and from the coverage check report on GitHub. One more location for coverage reporting is not valuable enough to occupy the top line of the user documentation.
The installation count is provided on the plugins.jenkins.io page and includes a 12 month history graph and easy access to detailed deployment statistics by plugin version and Jenkins core version.
Testing done
Confirmed that the page renders correctly on GitHub.
Submitter checklist