The Wayback Machine - https://web.archive.org/web/20201219053610/https://github.com/iterative/dvc/pull/3373
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

metadata: add Zenodo, tidy badges and keywords #3373

Merged
merged 7 commits into from Feb 21, 2020
Merged

Conversation

@casperdcl
Copy link
Member

@casperdcl casperdcl commented Feb 20, 2020

  • add Zenodo badge
    • this is a custom "all version" one which is nicer as it always points to the latest release. Yes, that sort of defeats one of the points of a DOI (version pinning) but we have version numbers for that. It's better to promote just one DOI to make it easy to track citations.
  • add formal citation for use in publications
  • add Zenodo metadata file (will control what appears in https://doi.org/10.5281/zenodo.3677553)
  • tidy and re-use badges
  • fix rst image syntax
  • ensure keywords match
    • setup.py
    • GitHib repo
    • Zenodo
  • fixes #2978
  • related #3233
casperdcl added 6 commits Feb 20, 2020
Fixes #2978
@casperdcl casperdcl self-assigned this Feb 20, 2020
@casperdcl casperdcl changed the title Badges metadata: add Zenodo, tidy badges and keywords Feb 20, 2020
"data-science", "data-version-control", "machine-learning", "git",
"developer-tools", "reproducibility", "collaboration", "ai", "python"],
"contributors": [
{"name": "DVC team", "type": "Other", "affiliation": "Iterative"}]

This comment has been minimized.

@casperdcl

casperdcl Feb 20, 2020
Author Member

Not sure if we want name: "DVC team" or name: "Iterative" or name: "iterative.ai" or something else... Same with "affilitation".

This comment has been minimized.

@shcheklein

shcheklein Feb 21, 2020
Member

are there example from Google or other companies? what usually people do? :)

This comment has been minimized.

@casperdcl

casperdcl Feb 21, 2020
Author Member

fyi affiliation can be blank and will show up when name is hovered over.

name should really match whatever we choose for the citation text (i.e. think of it as an "author" field)

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 +253 to +254

This comment has been minimized.

@casperdcl

casperdcl Feb 20, 2020
Author Member

Again, not sure about capitalisation and exact wording

This comment has been minimized.

@elleobrien

elleobrien Feb 20, 2020
Member

I think you can write, Iterative, *Data Version Control (DVC)*. No need to say "Git for Data & Models"

This comment has been minimized.

@shcheklein

shcheklein Feb 20, 2020
Member

let's discuss this with @dmpetrov ... we need to get it right.

  • do we need to mention org at all? Iterative?
  • do we optimize for certain keywords. I would say "Git for Data" is important for us, even though Data Version Control is even more important.

but may be you are right, @andronovhopf and we should go with a clean and nice, simple version 🤔

This comment has been minimized.

@elleobrien

elleobrien Feb 21, 2020
Member

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.

This comment has been minimized.

@casperdcl

casperdcl Feb 21, 2020
Author Member

I think @shcheklein was referring to keywords (buzzwords) to use in our recommended citation

This comment has been minimized.

@elleobrien

elleobrien Feb 21, 2020
Member

ah gotcha

@shcheklein
Copy link
Member

@shcheklein shcheklein commented Feb 20, 2020

Screen Shot 2020-02-20 at 3 16 11 PM

@casperdcl is it expected? it looks too long? can we do two lines, for example?

@casperdcl
Copy link
Member Author

@casperdcl casperdcl commented Feb 21, 2020

@casperdcl is it expected? it looks too long? can we do two lines, for example?

Silly oversight on my part; fixed now.

@efiop
efiop approved these changes Feb 21, 2020
@efiop efiop merged commit ae99e1b into iterative:master Feb 21, 2020
4 checks passed
4 checks passed
DeepSource: Python Analysis Passed: No blocking issues detected.
Details
Travis CI - Pull Request Build Passed
Details
codeclimate All good!
Details
restyled No differences
Details
@casperdcl
Copy link
Member Author

@casperdcl casperdcl commented Feb 21, 2020

Er @efiop I think this was still under review

@efiop
Copy link
Member

@efiop efiop commented Feb 21, 2020

@casperdcl Oh, sorry, is anything wrong in this PR? It got 2 approvals so I've merged it 🤔

EDIT: ok, I'm blind. Now I do see the comments. Well, if there will be any requested changes, let's just address them on top, I don't think there is any harm done here.

@casperdcl casperdcl deleted the casperdcl:badges branch Feb 21, 2020
@casperdcl casperdcl restored the casperdcl:badges branch Feb 21, 2020
@casperdcl casperdcl mentioned this pull request Feb 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.