metadata: add Zenodo, tidy badges and keywords #3373
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| { | ||
| "title": "DVC: Data Version Control - Git for Data & Models", | ||
| "keywords": [ | ||
| "data-science", "data-version-control", "machine-learning", "git", | ||
| "developer-tools", "reproducibility", "collaboration", "ai", "python"], | ||
| "contributors": [ | ||
| {"name": "DVC team", "type": "Other", "affiliation": "Iterative"}] | ||
| } | ||
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,4 @@ | ||
| |Banner| | ||
|
|
||
| `Website <https://dvc.org>`_ | ||
| • `Docs <https://dvc.org/doc>`_ | ||
|
|
@@ -10,33 +8,7 @@ | |
| • `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| | ||
|
|
||
| | | ||
|
|
||
|
|
@@ -79,9 +51,7 @@ to store data and model files seamlessly out of Git, while preserving almost the | |
| were stored in Git itself. To store and share the data cache, DVC supports multiple remotes - any cloud (S3, Azure, | ||
| Google Cloud, etc) or any on-premise network storage (via SSH, for example). | ||
|
|
||
| |Flowchart| | ||
|
|
||
| The DVC pipelines (computational graph) feature connects code and data together. It is possible to explicitly | ||
| specify all steps required to produce a model: input dependencies including data, commands to run, | ||
|
|
@@ -148,6 +118,8 @@ Homebrew | |
| Conda (Anaconda) | ||
| ---------------- | ||
|
|
||
| |Conda| | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| conda install -c conda-forge dvc | ||
|
|
@@ -157,6 +129,8 @@ Currently, this includes support for Python versions 2.7, 3.6 and 3.7. | |
| Snap (Snapcraft) | ||
| ---------------- | ||
|
|
||
| |Snap| | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| snap install dvc --classic | ||
|
|
@@ -206,40 +180,43 @@ Comparison to related technologies | |
|
|
||
| Contributing | ||
| ============ | ||
|
|
||
| |Maintainability| |Donate| | ||
|
|
||
| Contributions are welcome! Please see our `Contributing Guide <https://dvc.org/doc/user-guide/contributing/core>`_ for more | ||
| details. | ||
|
|
||
| .. image:: https://sourcerer.io/fame/efiop/iterative/dvc/images/0 | ||
| :target: https://sourcerer.io/fame/efiop/iterative/dvc/links/0 | ||
| :alt: 0 | ||
|
|
||
| .. image:: https://sourcerer.io/fame/efiop/iterative/dvc/images/1 | ||
| :target: https://sourcerer.io/fame/efiop/iterative/dvc/links/1 | ||
| :alt: 1 | ||
|
|
||
| .. image:: https://sourcerer.io/fame/efiop/iterative/dvc/images/2 | ||
| :target: https://sourcerer.io/fame/efiop/iterative/dvc/links/2 | ||
| :alt: 2 | ||
|
|
||
| .. image:: https://sourcerer.io/fame/efiop/iterative/dvc/images/3 | ||
| :target: https://sourcerer.io/fame/efiop/iterative/dvc/links/3 | ||
| :alt: 3 | ||
|
|
||
| .. image:: https://sourcerer.io/fame/efiop/iterative/dvc/images/4 | ||
| :target: https://sourcerer.io/fame/efiop/iterative/dvc/links/4 | ||
| :alt: 4 | ||
|
|
||
| .. image:: https://sourcerer.io/fame/efiop/iterative/dvc/images/5 | ||
| :target: https://sourcerer.io/fame/efiop/iterative/dvc/links/5 | ||
| :alt: 5 | ||
|
|
||
| .. image:: https://sourcerer.io/fame/efiop/iterative/dvc/images/6 | ||
| :target: https://sourcerer.io/fame/efiop/iterative/dvc/links/6 | ||
| :alt: 6 | ||
|
|
||
| .. image:: https://sourcerer.io/fame/efiop/iterative/dvc/images/7 | ||
| :target: https://sourcerer.io/fame/efiop/iterative/dvc/links/7 | ||
| :alt: 7 | ||
|
|
||
| Mailing List | ||
| ============ | ||
|
|
@@ -253,3 +230,51 @@ This project is distributed under the Apache license version 2.0 (see the LICENS | |
|
|
||
| By submitting a pull request to this project, you agree to license your contribution under the Apache license version | ||
| 2.0 to this project. | ||
|
|
||
| Citation | ||
| ======== | ||
|
|
||
| |DOI| | ||
|
|
||
| Iterative, *DVC: Data Version Control - Git for Data & Models* (2020) | ||
| `DOI:10.5281/zenodo.012345 <https://doi.org/10.5281/zenodo.3677553>`_. | ||
|
Comment on lines
+239
to
+240
There was a problem hiding this comment. Again, not sure about capitalisation and exact wording There was a problem hiding this comment. I think you can write, There was a problem hiding this comment. let's discuss this with @dmpetrov ... we need to get it right.
but may be you are right, @andronovhopf and we should go with a clean and nice, simple version 🤔 There was a problem hiding this comment. I don't think it's terribly important to optimize for keywords in this context since Zenodo doesn't look built for discovering new projects; just tagging the repo with a DOI. not sure though. There was a problem hiding this comment. I think @shcheklein was referring to keywords (buzzwords) to use in our recommended citation |
||
|
|
||
| .. |Banner| image:: https://dvc.org/static/img/logo-github-readme.png | ||
| :target: https://dvc.org | ||
| :alt: DVC logo | ||
|
|
||
| .. |Release| image:: https://img.shields.io/badge/release-ok-brightgreen | ||
| :target: https://travis-ci.com/iterative/dvc | ||
| :alt: Release | ||
|
|
||
| .. |CI| image:: https://img.shields.io/travis/com/iterative/dvc/master?label=dev | ||
| :target: https://travis-ci.com/iterative/dvc | ||
| :alt: Travis dev branch | ||
|
|
||
| .. |Maintainability| image:: https://codeclimate.com/github/iterative/dvc/badges/gpa.svg | ||
| :target: https://codeclimate.com/github/iterative/dvc | ||
| :alt: Code Climate | ||
|
|
||
| .. |Coverage| image:: https://codecov.io/gh/iterative/dvc/branch/master/graph/badge.svg | ||
| :target: https://codecov.io/gh/iterative/dvc | ||
| :alt: Codecov | ||
|
|
||
| .. |Donate| image:: https://img.shields.io/badge/patreon-donate-green.svg | ||
| :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 | ||
|
|
||
| .. |DOI| image:: https://img.shields.io/badge/DOI-10.5281/zenodo.3677553-blue.svg | ||
| :target: https://doi.org/10.5281/zenodo.3677553 | ||
| :alt: DOI | ||
|
|
||
| .. |Flowchart| image:: https://dvc.org/static/img/flow.gif | ||
| :target: https://dvc.org/static/img/flow.gif | ||
| :alt: how_dvc_works | ||
This file contains 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
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.
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.
Not sure if we want
name: "DVC team"orname: "Iterative"orname: "iterative.ai"or something else... Same with"affilitation".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.
are there example from Google or other companies? what usually people do? :)
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.
fyi
affiliationcan be blank and will show up whennameis hovered over.nameshould really match whatever we choose for the citation text (i.e. think of it as an "author" field)