developmentseed / eoAPI

[Active Development] Earth Observation API (Metadata, Raster and Vector services)
https://eoapi.dev
MIT License
206 stars 22 forks source link

Improve Documentation for Onboarding and Data Ingestion #95

Closed zacharyDez closed 1 year ago

zacharyDez commented 1 year ago

Description

While setting up eoAPI for my project, I noticed some potential areas of improvement in the documentation, especially concerning loading data into eoAPI. The example documents on loading data are currently situated within the demo folder and aren't directly referenced in the README. In addition, I encountered a few friction points:

I suggest we create a more streamlined onboarding experience for developers, particularly around data loading, which was the most time-consuming and confusing step in my experience.

Suggested changes

To make the onboarding process smoother, I propose adding the following documentation:

zacharyDez commented 1 year ago

Using MAXAR_opendata_to_pgstac as referenced in the getting started documentation.