-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
docs: update badges #3380
Conversation
Add |Choco| Add |Brew| Fix style for |Conda| Add |PyPI| Add |Packages| Fixes iterative#3233 Related https://github.com/iterative/dvc.org/issues/904
|Release| |CI| |Maintainability| |Coverage| |Donate| |DOI| | ||
|
||
|Snap| |Choco| |Brew| |Conda| |PyPI| |Packages| |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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:
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.
There was a problem hiding this comment.
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.
|Choco|
|Brew|
|Conda|
|PyPI|
|Packages|
import-url/update --jobs
affects uploading with--to-remote
dvc.org#3233