-
Notifications
You must be signed in to change notification settings - Fork 139
Open
Labels
impact: documentationImprovements or additions to documentationImprovements or additions to documentationtype: experience reportA report of the user's personal subjective experience using this softwareA report of the user's personal subjective experience using this software
Description
"Access" documentation is scatted all over the place, some of it more helpful/ detailed than others. I think this info should be consolidated and revised. If we end up changing things so that the User Guide has a new purpose (#1194), some of this may be alleviated. Here are the inconsistencies/ quirks I noted:
- In How-to > Access data: downloading to a local folder works, but Options 1 and 3 don’t have enough context. It’s not clear what the expected result is (e.g., a list of links?). Perhaps redundant with new expanded User Guide > Access page?
- In the User Guide > Access page there is a text box with a link to the page the user is already on... which is a bit odd. Maybe this was meant to link to Authentication? I'm also on the train of thought that if we are going to include code snippets, they should be full snippets. So the whole process, from start to finish, which because most of these functions can be done with a handful of code lines, I don't think should make things too lengthy. But for example, in the Downloading Data section, the first thing the user would run is "filelist = earthaccess.download(results)"... but if they came to this page early on, they would not have results defined, or even maybe have logged in with earthaccess (wether manually or with a .netrc).
- In How-to > Download data from on-prem location: works, but redundant with other “access” pages. This page actually shows code from start to finish, though, which I think is good.
- In How-to > Direct S3 access: currently “Coming soon” and this content is touched on elsewhere.
- It seems to me that the How-to > Download pages could be combined and all that content could live in the Access (maybe renamed to Download?) page instead. It is already touched on there anyways.
- Some of the How-to pages seem broken as of now? They are not rendering properly.
Overall, access/download-related material is spread across too many pages with varying levels of detail/ completeness... I don't think a user will want to open all of the pages to sort out which one actually has what they are looking for.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
impact: documentationImprovements or additions to documentationImprovements or additions to documentationtype: experience reportA report of the user's personal subjective experience using this softwareA report of the user's personal subjective experience using this software
Type
Projects
Status
🆕 New