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:
The existing documentation should provide direct instructions on setting up the dependencies.
There are additional steps to configure the VPC for titiler to visualize the underlying data when running eoAPI with docker-compose, which are not covered in the current docs.
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:
Getting Started Section in README: A new section in the README that guides the user through loading an interesting sample dataset into eoAPI, showcasing its capabilities without requiring any network rule configurations. This could also include a walkthrough of critical capabilities and might be a suitable replacement for the current services section.
Detailed Ingestion Workflow Document: A comprehensive document detailing the ingestion workflow and structure, including links to relevant examples for better understanding.
Could we provide a containerized service that adds some example data? @vincentsarago @ranchodeluxe @bitner
Description
While setting up
eoAPI
for my project, I noticed some potential areas of improvement in the documentation, especially concerning loading data intoeoAPI
. The example documents on loading data are currently situated within thedemo
folder and aren't directly referenced in the README. In addition, I encountered a few friction points:titiler
to visualize the underlying data when runningeoAPI
withdocker-compose
, which are not covered in the current docs.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:
eoAPI
, showcasing its capabilities without requiring any network rule configurations. This could also include a walkthrough of critical capabilities and might be a suitable replacement for the current services section.