DOC: Update citation file with JOSS paper reference

skypyproject / skypy

SkyPy: A package for modelling the Universe.

BSD 3-Clause "New" or "Revised" License

118 stars 38 forks source link

DOC: Update citation file with JOSS paper reference #496

Closed Lucia-Fonseca closed 2 years ago

Lucia-Fonseca commented 3 years ago

Description

This PR updates the citation guidelines to include the JOSS paper and link the rst file to the documentation page. Merging this PR successfully closes #495 .

Checklist

[x] Follow the Contributor Guidelines
[ ] Write unit tests
[x] Write documentation strings
[x] Assign someone from your working team to review this pull request
[x] Assign someone from the infrastructure team to review this pull request

Lucia-Fonseca commented 3 years ago

This is done. Can anyone check the bib file and the Zenodo reference therein? Thank you!

Lucia-Fonseca commented 3 years ago

Docs are failing but it was working fine on my computer

rrjbca commented 3 years ago

Docs are failing but it was working fine on my computer

You should add developer/citation under the developer toctree in index.rst. Although I would suggest moving citation.rst into docs/project as this seems more appropriate than docs/developer

Lucia-Fonseca commented 3 years ago

The Download BibTeX button is not working. Any ideas? It might be spaces but I cannot make it work consistently

Lucia-Fonseca commented 3 years ago

Is there a better place for the main.bib file?

Lucia-Fonseca commented 3 years ago

Ready for review

rrjbca commented 3 years ago

I don't think having a bib file and a download link is a good idea:

The download link doesn't render in GitHub: https://github.com/Lucia-Fonseca/skypy/blob/citation/CITATION.rst
The zenodo reference necessarily points to a single release. We ask people to cite the version they used. Even if we kept it up to date with the most recent release (we won't) it is the wrong reference for people using older versions.

Lucia-Fonseca commented 3 years ago

I don't think having a bib file and a download link is a good idea: Oh, I liked it but yes, it does not render in GitHub.

The download link doesn't render in GitHub: https://github.com/Lucia-Fonseca/skypy/blob/citation/CITATION.rst

The zenodo reference necessarily points to a single release. We ask people to cite the version they used. Even if we kept it up to date with the most recent release (we won't) it is the wrong reference for people using older versions. True

ntessore commented 3 years ago

We could display the JOSS badge somewhere as well:

rrjbca commented 3 years ago

We could display the JOSS badge somewhere as well:

It's already on the README. Do you want it in the docs also?

ntessore commented 3 years ago

Just an idea, I like that big green box. On the other hand, someone on the CITATION page has already clicked and gone there on purpose, so perhaps not necessary to decorate the page any further.

rrjbca commented 3 years ago

It could work, instead of the current text which is a bit wordy and clumsy we could have:

The BibTex entries can be found at the following links:

Lucia-Fonseca commented 3 years ago

The badges

do not render well in the docs

Lucia-Fonseca commented 3 years ago

Ready

Lucia-Fonseca commented 2 years ago

After offline conversations, we agree the citation would be Amara et al. 2021 and not the preferred option SkyPy Collaboration 2021 for justified reasons. Therefore, this PR can be merged.