Add Zenodo DOI to recommended citation

[adrn]

I need to adjust the text a little bit, so this is still a WIP, but I wanted to open this to start some discussion.

Currently in this PR, I added the bibtex record for the latest Zenodo record and added the record to the "copy" button, and added a link to the latest Zenodo DOI as a badge. The badge always links to the current version, but the bibtex record would require us to manually update it whenever a new version is released. I'm thinking we might want to link to Zenodo but not automatically add the record to the "copy" button, but wanted to hear your thoughts.

Fixes #291

[bsipocz]

Any way to automate this? I run into the issue so many places of the zenodo entry being so far behind the actual release that it would be superb not to end up there with astropy.

[astrofrog]

Not easily but we should just make it part of the release process

[astrofrog]

I can write some instructions for the dev docs

[astrofrog]

Ah wait did you mean uploading to Zenodo, or updating this page?

[bsipocz]

I meant this bibtex here. Creating the zenodo entry is doable automatically afaik (or at least was with GH services)

[eteq]

Yeah I'm with Brigitta here. The copy-and-paste mechanism seems problematic if it gets you whatever the last one is the web site actually got updated to show.

[eteq]

@adrn - I like the idea of this, but @bsipocz raised a very good point that it's going to be a pain to keep the entry on this page in sync with the core release. Three possibilities come to mind:

1. Instead of including the actual example bibtex entry on the page, include just the part that says "cite the right zenodo entry" and link to the "rollup DOI": https://doi.org/10.5281/zenodo.1461536 (and state clearly "but be sure to pick the right version"). Downside is that a lot of folks will just ignore that.
2. Include a bibtex entry but have it be intentionally broken. I.e., insert text like \REPLACE THIS ENTRY WITH THE RIGHT VERSION ENTRY to force people to then do something about it instead of blindly pasting
3. Build some sort of javascript machinery that auto-populates the text by reading the latest Zenodo entry from https://doi.org/10.5281/zenodo.1461536 and fills in the bibtex on that basis. Downside is that a lot of users will probably use that even though it's the wrong version.

If it were me I'd go with 1 because that seems safest and most maintainable. But I'd be up for any of the above, what do you think @adrn ?

[astrofrog]

Once people copy the acknowledgment they will use the same one until they retire so I’m in favour of 1.

[pllim]

@adrn , are you still interested in wrapping this up? Thanks!

[adrn]

The last Zenodo record was for v3.0.5, so astropy/astropy#10611 needs to be resolved before I can finalize this!

[adrn]

Oops - accidental close. I'll leave this open until we make a decision in the other issue ^.

[pllim]

Is this PR going anywhere? It has conflict now.