Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update badges #3380

Merged
merged 4 commits into from
Feb 27, 2020
Merged

docs: update badges #3380

merged 4 commits into from
Feb 27, 2020

Conversation

casperdcl
Copy link
Contributor

@casperdcl casperdcl commented Feb 21, 2020

Comment on lines +11 to +13
|Release| |CI| |Maintainability| |Coverage| |Donate| |DOI|

|Snap| |Choco| |Brew| |Conda| |PyPI| |Packages|
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really need this number of badges? Maybe, we could just put a same page link to Installation section?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@skshetry Good point. So far the idea was that it is conveinient to see all of those badges, as you are intuitively looking for them whenever you are checking out a new project. Hiding them will make it less visible, so I'm not sure if it is a good thing. It does get a bit crowded, you are right.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed, though if we want to drop things arguably |Release| |CI| |Maintainability| |Coverage| are least relevant to end users.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, looking at readme now, I do see that it is way too crowded with installation badges :(

Indeed, though if we want to drop things arguably |Release| |CI| |Maintainability| |Coverage| are least relevant to end users.

That is not true, maintainability/coverage/ci all matters, as it is a sign of a well-maintained project. Those should not be removed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't look too crowded to me:

image

Showing we support different installation options means more users likely to bother reading on an actually install. Maintainability/coverage/ci (in terms of users, not devs) are either completely ignored or assumed to be perfect - in both cases they don't necessarily need to be at the top of the readme if we want to drop some badges.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel that 19 links at the top is too many. It makes it hard to scan through when the objective of having top-links and badges is to be quick and easy.

@efiop efiop merged commit 35a6e0f into iterative:master Feb 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhances DVC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

readme: update badges
4 participants