Skip to content

docs: update badges #3380

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Feb 27, 2020
Merged

docs: update badges #3380

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
aa46cd1
docs: add and update badges
casperdcl Feb 21, 2020
6d567c9
docs: add badge logos
casperdcl Feb 21, 2020
a02da49
docs: minor badge tidy
casperdcl Feb 21, 2020
e3d4c3f
docs: add choco install, add OS, update order
casperdcl Feb 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 59 additions & 27 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
• `Tutorial <https://dvc.org/doc/get-started>`_
• `Mailing List <https://sweedom.us10.list-manage.com/subscribe/post?u=a08bf93caae4063c4e6a351f6&id=24c0ecc49a>`_

|Release| |CI| |Maintainability| |Coverage| |Donate| |Conda| |Snap| |DOI|
|Release| |CI| |Maintainability| |Coverage| |Donate| |DOI|

|Snap| |Choco| |Brew| |Conda| |PyPI| |Packages|
Comment on lines +11 to +13
Copy link
Collaborator

@skshetry skshetry Feb 27, 2020

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

@efiop efiop Feb 27, 2020

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

@casperdcl casperdcl Feb 27, 2020

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

@efiop efiop Feb 28, 2020

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

@casperdcl casperdcl Feb 28, 2020

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
Collaborator

@skshetry skshetry Feb 28, 2020

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.


|

Expand Down Expand Up @@ -89,32 +91,36 @@ Installation
There are four options to install DVC: ``pip``, Homebrew, Conda (Anaconda) or an OS-specific package.
Full instructions are `available here <https://dvc.org/doc/get-started/install>`_.

pip (PyPI)
----------
Snap (Snapcraft/Linux)
----------------------

|Snap|

.. code-block:: bash

pip install dvc
snap install dvc --classic

Depending on the remote storage type you plan to use to keep and share your data, you might need to specify
one of the optional dependencies: ``s3``, ``gs``, ``azure``, ``oss``, ``ssh``. Or ``all`` to include them all.
The command should look like this: ``pip install dvc[s3]`` (in this case AWS S3 dependencies such as ``boto3``
will be installed automatically).
This corresponds to the latest tagged release.
Add ``--edge`` for the latest ``master`` version.

To install the development version, run:
Choco (Chocolatey/Windows)
--------------------------

|Choco|

.. code-block:: bash

pip install git+git://github.com/iterative/dvc
choco install dvc

Brew (Homebrew/Mac OS)
----------------------

Homebrew
--------
|Brew|

.. code-block:: bash

brew install dvc


Conda (Anaconda)
----------------

Expand All @@ -126,21 +132,31 @@ Conda (Anaconda)

Currently, this includes support for Python versions 2.7, 3.6 and 3.7.

Snap (Snapcraft)
----------------
pip (PyPI)
----------

|Snap|
|PyPI|

.. code-block:: bash

snap install dvc --classic
pip install dvc

This corresponds to the latest tagged release.
Add ``--edge`` for the latest ``master`` version.
Depending on the remote storage type you plan to use to keep and share your data, you might need to specify
one of the optional dependencies: ``s3``, ``gs``, ``azure``, ``oss``, ``ssh``. Or ``all`` to include them all.
The command should look like this: ``pip install dvc[s3]`` (in this case AWS S3 dependencies such as ``boto3``
will be installed automatically).

To install the development version, run:

.. code-block:: bash

pip install git+git://github.com/iterative/dvc

Package
-------

|Packages|

Self-contained packages for Linux, Windows, and Mac are available. The latest version of the packages
can be found on the GitHub `releases page <https://github.com/iterative/dvc/releases>`_.

Expand Down Expand Up @@ -244,11 +260,11 @@ Iterative, *DVC: Data Version Control - Git for Data & Models* (2020)
:alt: DVC logo

.. |Release| image:: https://img.shields.io/badge/release-ok-brightgreen
:target: https://travis-ci.com/iterative/dvc
:target: https://travis-ci.com/iterative/dvc/branches
:alt: Release

.. |CI| image:: https://img.shields.io/travis/com/iterative/dvc/master?label=dev
:target: https://travis-ci.com/iterative/dvc
.. |CI| image:: https://img.shields.io/travis/com/iterative/dvc/master?label=dev&logo=travis
:target: https://travis-ci.com/iterative/dvc/builds
:alt: Travis dev branch

.. |Maintainability| image:: https://codeclimate.com/github/iterative/dvc/badges/gpa.svg
Expand All @@ -259,18 +275,34 @@ Iterative, *DVC: Data Version Control - Git for Data & Models* (2020)
:target: https://codecov.io/gh/iterative/dvc
:alt: Codecov

.. |Donate| image:: https://img.shields.io/badge/patreon-donate-green.svg
.. |Donate| image:: https://img.shields.io/badge/patreon-donate-green.svg?logo=patreon
:target: https://www.patreon.com/DVCorg/overview
:alt: Donate

.. |Conda| image:: https://anaconda.org/conda-forge/dvc/badges/version.svg
:target: https://anaconda.org/conda-forge/dvc
:alt: Conda-forge

.. |Snap| image:: https://img.shields.io/badge/snap-install-82BEA0.svg?logo=snapcraft
:target: https://snapcraft.io/dvc
:alt: Snapcraft

.. |Choco| image:: https://img.shields.io/chocolatey/v/dvc?label=choco
:target: https://chocolatey.org/packages/dvc
:alt: Chocolatey

.. |Brew| image:: https://img.shields.io/homebrew/v/dvc?label=brew
:target: https://formulae.brew.sh/formula/dvc
:alt: Homebrew

.. |Conda| image:: https://img.shields.io/conda/v/conda-forge/dvc.svg?label=conda&logo=conda-forge
:target: https://anaconda.org/conda-forge/dvc
:alt: Conda-forge

.. |PyPI| image:: https://img.shields.io/pypi/v/dvc.svg?label=pip&logo=PyPI&logoColor=white
:target: https://pypi.org/project/dvc
:alt: PyPI

.. |Packages| image:: https://img.shields.io/github/v/release/iterative/dvc?label=deb|pkg|rpm|exe&logo=GitHub
:target: https://github.com/iterative/dvc/releases/latest
:alt: deb|pkg|rpm|exe

.. |DOI| image:: https://img.shields.io/badge/DOI-10.5281/zenodo.3677553-blue.svg
:target: https://doi.org/10.5281/zenodo.3677553
:alt: DOI
Expand Down