add papers to README.rst #1809
add papers to README.rst #1809
Conversation
Add new papers with links to docs.
|
addresses issue #1750 |
There was a problem hiding this comment.
@kchilleri, very nice first PR! Some things to consider in-line. Happy to chat if you have questions.
README.rst
Outdated
| * A more technical resource is our Supercomputing 2017 paper: | ||
| https://dl.acm.org/citation.cfm?id=3126925 | ||
| * A more technical resource is our Supercomputing 2017 paper: https://doi.org/10.1145/3126908.3126925 | ||
|
|
||
| * Our approach to deploying scientific applications in HPC using Charliecloud’s layer-free, Git-based container | ||
| build cache: https://doi.org/10.1145/3624062.3624585 | ||
|
|
||
| * A performance comparison between three HPC-specific container technologies against a bare metal implementation: https://ieeexplore.ieee.org/document/8950978 | ||
|
|
||
| * Demonstration of how low-privilege containers solve the increasing demand of software flexibility: https://doi.org/10.6084/m9.figshare.14396099 |
There was a problem hiding this comment.
Listing the links twice seems awkward to me. One possible solution: remove the technical papers from here, change "how do I credit" to "Publications", and add a pointer to that section below.
That said, I really like how you added a 1-sentence summary for each paper and I want to keep those. Let’s re-frame those into a description of the findings/outcome rather than what we did, though.
README.rst
Outdated
| * Reid Priedhorsky and Tim Randles. "Charliecloud: unprivileged containers for user-defined | ||
| software stacks in HPC", 2017. In *Proc. Supercomputing*. DOI: `10.1145/3126908.3126925 <https://doi.org/10.1145/3126908.3126925>`_. |
There was a problem hiding this comment.
I forgot to mention we use curly quotes in the source .rst files.
There was a problem hiding this comment.
What is this about? The DOI link reference?
There was a problem hiding this comment.
It’s the paper title. E.g. you want:
Reid Priedhorsky and Tim Randles. “Charliecloud: unprivileged containers for user-defined
software stacks in HPC”, 2017.
There was a problem hiding this comment.
It’s particularly subtle because Sphinx curlifies the HTML pages automatically and usually gets it right. I think maybe it’s so the man pages get curly quotes too??
Add new papers with links to docs.