add file hashes to doc #170
Conversation
We have a plan to write a script to zip and upload new data. Creating the sha would be part of that, and we'll investigate whether we can automate updating the docs as well. |
There was a problem hiding this comment.
Thanks Steve, looks good. It's helpful to have the instructions for generating the checksums documented along with the checksums themselves -- I have never bothered to validate checksums for anything before because I didn't know how to do it and didn't want to bother looking it up.
Is there an easy way within the terminal to verify that the checksums match besides visually inspecting them?
In Linux you can copy/paste the hash into a file and then run a command that checks the hash in the file against the generated one. You can also use |
docs/source/input_data/index.rst
Outdated
| If after downloading the file a second time the checksums still do not match, | ||
| please open a new `Data access request <https://github.com/ihmeuw/pseudopeople/issues/new?assignees=&labels=&template=data_access_request.yml>`_ | ||
| using the template under the `Issues tab <https://github.com/ihmeuw/pseudopeople/issues>`_ | ||
| on pseudopeople's GitHub page. |
There was a problem hiding this comment.
I think this should just be a "normal" issue -- it's more like a bug report than a data access request IMO.
| .. code-block:: console | ||
|
|
||
| $ sha256sum PATH/TO/ZIP | ||
|
|
There was a problem hiding this comment.
This isn't on my Mac. I have shasum -a 256 PATH/TO/ZIP
There was a problem hiding this comment.
Weird, my mac has both. Ok, will update
Title: Add SHA-256 hashes to docs
Description
After discussion, we decided that the approach to checksums should be
one per zipped package and provided to the user via documentation. This PR
adds those hashes to the docs as well as a very brief description of what
they are an how to use them.
Testing
na