add instructions to reset AWS keys when downloading HCP data

[josephmje]

Closes #620

Thank you @adswa for your feedback on my original issue. I've made some changes using the markup you suggested there. Should I also document the other alternatives you mentioned (eg. modifying keyring_pass.cfg or setting environment variables)? Or do you think this solution would cover most people's computers?

[welcome]

(Image: CC-BY license, The Turing Way Community, & Scriberia. Zenodo. http://doi.org/10.5281/zenodo.3332808) Wohoo! 🎉 Thanks for opening your first pull request to the DataLad Handbook! 😎 We really appreciate your time and effort to contribute to the project - you're amazing! 👏

[adswa]

Thanks much @josephmje! Also for finding and fixing all those spelling and syntax errors :)

Should I also document the other alternatives you mentioned (eg. modifying keyring_pass.cfg or setting environment variables)?

It would be fantastic if you could mention that one could set environment variables with their credentials as an alternative, and the names of the corresponding environment variables (DATALAD_hcp_s3_key_id and DATALAD_hcp_s3_secret_id). There is a bit of general information about environment variables in a footnote in the section on configurations, and you can add a reference to it with the following markup:

see :ref:`this footnote <envvars>` for more details

where you can add arbitrary text in place of "this footnote"

I've added a diff patch on how to fix the indentation error that Sphinx complains about below.

@all-contributors please add @josephmje for content

[adswa]

Here is a preview of the build (you can also find it at https://datalad-handbook--622.org.readthedocs.build/en/622/usecases/HCP_dataset.html):

In order to render the bullet point list correctly, Sphinx needs an empty line before and after the list. The following patch would make it work:

diff --git a/docs/usecases/HCP_dataset.rst b/docs/usecases/HCP_dataset.rst
index 8d42ad92..738ef26c 100644
--- a/docs/usecases/HCP_dataset.rst
+++ b/docs/usecases/HCP_dataset.rst
@@ -421,6 +421,7 @@ retrieve data right away.
 
    After launching Python, import the ``keyring`` package and use the 
    ``set_password()`` function. This function takes 3 arguments:
+
    * ``system``: "datalad-hcp-s3" in this case
    * ``username``: "key_id" if modifying the AWS access key ID and 
      "secret_id" if modifying the secret access key

[adswa]

Good thing the bot didn't seem to listen, I forgot an emoji key.

hey @all-contributors please add @josephmje for content, bug

[allcontributors]

@adswa

I've put up a pull request to add @josephmje! 🎉

[adswa]

Great, thanks! I will merge this now. :)

Just to be sure this information wasn't lost in past conversations: Please feel free to add your information to .zenodo.json or just paste it here and I can include it. With the upcoming DataLad 0.14.0 release there will be a new handbook release, and everyone listed in the zenodo.json file becomes a co-author on https://zenodo.org/record/3905791#.X9HYZSUo8UE with every new release.

[welcome]

(Image: CC-BY license, The Turing Way Community, & Scriberia. Zenodo. http://doi.org/10.5281/zenodo.3332808) Congrats on merging your first pull request! 🎉 The DataLad Handbook team appreciates your contribution greatly, and we want to say thanks! 💖 Now go ahead and share your first merge with your colleagues, you got yourself this brag right! 😄 🎁

[josephmje]

Thank you @adswa for the review and Sphinx tips! I've added my information here:

    {
      "affiliation": "The Centre for Addiction and Mental Health",
      "name": "Joseph, Michael",
      "orcid": "0000-0002-0068-230X"
    }

[adswa]

Great, thanks - done in #628