search

NCEAS / metajam

Bringing data and metadata togetheR
https://nceas.github.io/metajam/
Apache License 2.0
16 stars 7 forks source link

Changes to README #138

Closed njlyon0 closed 2 years ago

njlyon0 commented 2 years ago

Julien Brun asked that I read over the package website (i.e., README.md) and identify any areas that could be more clear. I identified the following points:

  1. I think the order of components on the page should be shifted slightly to match the actual metajam workflow

    • I think it could be (1) a brief intro to the workflow, (2) how to get the URL for the data you want, (3) downloading the data with metajam, and (4) reading in data with metajam
    • Currently it is (1) download data with URL, (2) how do you get URL, (3) reading in data which I found confusing at first because I was thinking “wait, how do I get the URL though?”

  2. You had a demo at the end of the presentation that was linked to this page that I thought was really helpful and could be directly added to this page

I forked the repository to implement these changes myself (again, at Julien's request) and am about to submit a pull request containing those changes.

njlyon0 commented 2 years ago

I submitted the pull request and am linking it here just for posterity.

I will close this issue once the request is accepted/denied to make sure that I'm not crowding your issue list.

Thanks for letting me be a (admittedly small) part of this!

njlyon0 commented 2 years ago

The pull request was merged (see above) so this issue's purpose is served!