Review documentation updates

developmentseed · May 24, 2024 · 7a73d12 · 7a73d12
1 parent ebab9d9
commit 7a73d12
Show file tree

Hide file tree

Showing 4 changed files with 170 additions and 196 deletions.
diff --git a/README.md b/README.md
@@ -1,64 +1,59 @@
+
 <p align="center">
   <img width="700" src="docs/logos/eoAPI.png"/>
   <p align="center">Create a full Earth Observation API with Metadata, Raster, and Vector services.</p>
 </p>
 
 <p align="center">
   <a href="https://github.com/developmentseed/eoAPI/blob/main/LICENSE" target="_blank">
-      <img src="https://img.shields.io/github/license/developmentseed/titiler.svg" alt="Downloads">
+    <img src="https://img.shields.io/github/license/developmentseed/titiler.svg" alt="Downloads">
   </a>
 </p>
 
 ---
 
-**Documentation**: <a href="https://eoapi.dev" target="_blank">https://eoapi.dev</a>
-
-**Source Code**: <a href="https://github.com/developmentseed/eoAPI" target="_blank">https://github.com/developmentseed/eoAPI</a>
+- **Documentation**: <a href="https://eoapi.dev" target="_blank">https://eoapi.dev</a>
+- **Source Code**: <a href="https://github.com/developmentseed/eoAPI" target="_blank">https://github.com/developmentseed/eoAPI</a>
 
 ---
 
-## **E**arth **O**bservation **API**
-
-`eoAPI` combines several *state-of-the-art* projects to create a full Earth Observation API. Each service can be used and deployed independently, but `eoAPI` creates the interconnections between each service:
-
-- **pgSTAC** database [https://github.com/stac-utils/pgstac](https://github.com/stac-utils/pgstac)
+## Earth Observation API
 
-- **STAC API** built on top of [https://github.com/stac-utils/stac-fastapi](https://github.com/stac-utils/stac-fastapi)
+`eoAPI` combines several state-of-the-art projects to create a full Earth Observation API. Each service can be used and deployed independently, but `eoAPI` creates the interconnections between each service:
 
-- **STAC Items And Mosaic Raster Tiles** API built on top of [https://github.com/stac-utils/titiler-pgstac](https://github.com/stac-utils/titiler-pgstac)
-
-- **OGC Features and Vector Tiles** API built on top of [https://github.com/developmentseed/tipg](https://github.com/developmentseed/tipg)
-
-- **A STAC Catalog browsing UI** based on the radiant earth browser : [https://github.com/radiantearth/stac-browser](https://github.com/radiantearth/stac-browser)
+- **pgSTAC** database: https://github.com/stac-utils/pgstac
+- **STAC API** built on top of: https://github.com/stac-utils/stac-fastapi
+- **STAC Items And Mosaic Raster Tiles** API built on top of: https://github.com/stac-utils/titiler-pgstac
+- **OGC Features and Vector Tiles** API built on top of: https://github.com/developmentseed/tipg
+- **A STAC Catalog browsing UI** based on the radiant earth browser: https://github.com/radiantearth/stac-browser
 
 ---
 
 ## 🌍 eoAPI: An Open-Source Community Project
 
 `eoAPI` is proudly open-source and driven by a dedicated community of contributors. We believe in the power of open collaboration and welcome anyone to contribute, discuss, and grow this tool. Join the conversations on [GitHub Discussions](https://github.com/developmentseed/eoAPI/discussions) and make a difference in the Earth Observation realm.
 
-
 ---
 
 ## Getting started
 
-The easiest way to start exploring the different eoAPI services is with *Docker*. Clone this repository and start the multi-container *Docker* applications using `Compose`:
+The easiest way to explore the different eoAPI services is with **Docker**. Clone this repository and start the multi-container **Docker** applications using `Compose`:
 
-```
+```bash
 git clone https://github.com/developmentseed/eoAPI.git
 cd eoAPI
 docker compose up
 ```
 
-Once the applications are *up*, you'll need to add STAC **Collections** and **Items** to the PgSTAC database. If you don't have these available, you can follow the [MAXAR open data demo](https://github.com/vincentsarago/MAXAR_opendata_to_pgstac) (or get inspired by the other [demos](https://github.com/developmentseed/eoAPI/tree/main/demo)).
+Once the applications are **up**, you'll need to add STAC **Collections** and **Items** to the PgSTAC database. If you don't have these available, you can follow the [MAXAR open data demo](https://github.com/vincentsarago/MAXAR_opendata_to_pgstac) (or get inspired by the other [demos](https://github.com/developmentseed/eoAPI/tree/main/demo)).
 
 Then you can start exploring your dataset with:
 
-  - the STAC Metadata service [http://localhost:8081](http://localhost:8081)
-  - the Raster service [http://localhost:8082](http://localhost:8082)
-  - the browser UI [http://localhost:8085](http://localhost:8085)
+- the STAC Metadata service: http://localhost:8081
+- the Raster service: http://localhost:8082
+- the browser UI: http://localhost:8085
 
-If you've added a vector dataset to the `public` schema in the Postgres database, they will be available through the **Vector** service at [http://localhost:8083](http://localhost:8083).
+If you've added a vector dataset to the `public` schema in the Postgres database, they will be available through the **Vector** service at http://localhost:8083.
 
 ### Local deployment
 
@@ -72,16 +67,14 @@ Alternatively, you may install the libraries and launch the applications manuall
 python -m pip install --upgrade virtualenv
 virtualenv .venv
 source .venv/bin/activate
-
 export DATABASE_URL=postgresql://username:[email protected]:5439/postgis  # Connect to the database of your choice
-
 python -m pip install uvicorn
 
 ###############################################################################
 # Install and launch the application
 # Select one of the following
-
 ###############################################################################
+
 # STAC
 python -m pip install "psycopg[binary,pool]" stac-fastapi-pgstac
 python -m uvicorn stac_fastapi.pgstac.app:app --port 8081 --reload
@@ -109,21 +102,21 @@ Note: Python libraries might have incompatible dependencies, which you can resol
 
 #### AWS CDK
 
-[eoapi-cdk](https://github.com/developmentseed/eoapi-cdk) defines a set of AWS CDK constructs that can be used to deploy eoAPI services on AWS. An official example usage of these constructs can be found at [eoapi-template](https://github.com/developmentseed/eoapi-template).
-
+[eoapi-cdk](https://github.com/developmentseed/eoapi-cdk) defines a set of AWS CDK constructs that can be used to deploy eoAPI services on AWS. An official example of these constructs is at [eoapi-template](https://github.com/developmentseed/eoapi-template).
 
 ## Deployment with custom runtimes
 
 An example of custom eoAPI runtimes and deployment can be found at [eoapi-devseed](https://github.com/developmentseed/eoapi-devseed).
 
 ## Contribution & Development
 
-We highly value and rely on our community! You can make a difference whether you're an expert or just getting started. Here's how:
+We highly value and rely on our community! Whether you're an expert or just getting started, you can make a difference. Here's how:
 
 - **Engage in Discussions**: Share your ideas, ask questions, or provide feedback through [GitHub Discussions](https://github.com/developmentseed/eoAPI/discussions). This is where most of our project conversations take place.
 - **Report Issues**: Found a bug or have a feature request? Raise it on our [issues page](https://github.com/developmentseed/eoAPI/issues).
 
 ---
+
 ## License
 
 At Development Seed, we believe in open collaboration and making tools and data more accessible. In line with this ethos, we've explicitly chosen a MIT license for `eoAPI`.
@@ -132,6 +125,6 @@ For full license details, see [LICENSE](https://github.com/developmentseed/eoAPI
 
 ## Authors
 
-Nurtured by [Development Seed](<http://developmentseed.org>)
+Nurtured by [Development Seed](http://developmentseed.org)
 
-See [contributors](https://github.com/developmentseed/eoAPI/graphs/contributors) for a listing of individual contributors.
+See [contributors](https://github.com/developmentseed/eoAPI/graphs/contributors) for a listing of individual contributors.
diff --git a/docs/src/customization.md b/docs/src/customization.md
@@ -1,14 +1,14 @@
-The **eoapi-devseed** repository (https://github.com/developmentseed/eoapi-devseed) hosts customized versions of each base service. The documentation below demonstrates how each service can be customized. The eoAPI services can work in parallel or in combination with each other.
 
----
+The **eoapi-devseed** [repository](https://github.com/developmentseed/eoapi-devseed) hosts customized versions of each base service. The documentation below demonstrates how each service can be customized. The eoAPI services can work in parallel or combination with each other.
+
 ## eoapi.stac
 
 Built on [stac-fastapi.pgstac](https://github.com/stac-utils/stac-fastapi-pgstac) application, adding a **`TiTilerExtension`** and a simple **`Search Viewer`**.
 
 The service includes:
 
-- Full **stac-fastapi** implementation - see [docs](http://localhost:8081/docs) if using the `docker-compose` configuration.
-- Simple STAC Search **viewer** - see [viewer](http://localhost:8081/index.html) if using the `docker-compose` configuration.
+- If you use the `docker-compose` configuration, see [docs](http://localhost:8081/docs) for the full `stac-fastapi` implementation.
+- Simple STAC Search viewer—see [viewer](http://localhost:8081/index.html) if you are using the `docker-compose` configuration.
 - **Proxy** to the tiler endpoint for STAC Items.
 
 When the `TITILER_ENDPOINT` environment variable is set (pointing to the `raster` application), additional endpoints will be added to the stac-fastapi application (see: [stac/extension.py](https://github.com/developmentseed/eoapi-devseed/blob/main/runtimes/eoapi/stac/eoapi/stac/extension.py)):
@@ -17,55 +17,54 @@ When the `TITILER_ENDPOINT` environment variable is set (pointing to the `raster
 - `/collections/{collectionId}/items/{itemId}/viewer`: Redirect to the `raster` viewer
 
 <p align="center">
-<img  alt="eoapi.stac OpenAPI documentation"src="https://github.com/developmentseed/eoAPI/assets/10407788/f7fc4e7f-079a-4007-8c4c-74ff9ca7b012">
-<img alt="Metadata STAC search viewer" src="https://github.com/developmentseed/eoAPI/assets/10407788/b1fd6aa8-aab9-4d58-9ad4-6e1069ed9473"/>
+  <img alt="eoapi.stac OpenAPI documentation" src="https://github.com/developmentseed/eoAPI/assets/10407788/f7fc4e7f-079a-4007-8c4c-74ff9ca7b012">
+  <img alt="Metadata STAC search viewer" src="https://github.com/developmentseed/eoAPI/assets/10407788/b1fd6aa8-aab9-4d58-9ad4-6e1069ed9473"/>
 </p>
 
 Code: [/runtimes/eoapi/stac](https://github.com/developmentseed/eoapi-devseed/tree/main/runtimes/eoapi/stac)
 
 ---
+
 ## eoapi.raster
 
 The dynamic tiler deployed within `eoapi-devseed` is built on top of [titiler-pgstac](https://github.com/stac-utils/titiler-pgstac) and [pgstac](https://github.com/stac-utils/pgstac). It enables large-scale mosaic based on the results of STAC search queries.
 
 The service includes all the default endpoints from **titiler-pgstac** application and:
 
 - `/`: a custom landing page with links to the different endpoints
-
-- `/mosaic/builder`: a virtual mosaic builder UI, which helps create and register STAC Search queries
-
-- `/collections`: a *secret* (not in OpenAPI documentation) endpoint used in the mosaic-builder page
-
+- `/mosaic/builder`: a virtual mosaic builder UI that helps create and register STAC Search queries
+- `/collections`: a secret (not in OpenAPI documentation) endpoint used in the mosaic-builder page
 - `/collections/{collection_id}/items/{item_id}/viewer`: a simple STAC Item viewer
 
 <p align="center">
-<img alt="eoapi.stac OpenAPI documentation" src="https://github.com/developmentseed/eoAPI/assets/10407788/aa08d796-f3b1-4f43-8021-cbddfff95d26">
-<img alt="Raster mosaic builder" src="https://github.com/developmentseed/eoAPI/assets/10407788/8f0c96e6-d80a-46ef-a34f-66e59c64a027"/>
-<img alt="STAC Item viewer" src="https://github.com/developmentseed/eoAPI/assets/10407788/be86f07e-4b05-4c78-87bf-8738daf1ee20">
+  <img alt="eoapi.stac OpenAPI documentation" src="https://github.com/developmentseed/eoAPI/assets/10407788/aa08d796-f3b1-4f43-8021-cbddfff95d26">
+  <img alt="Raster mosaic builder" src="https://github.com/developmentseed/eoAPI/assets/10407788/8f0c96e6-d80a-46ef-a34f-66e59c64a027"/>
+  <img alt="STAC Item viewer" src="https://github.com/developmentseed/eoAPI/assets/10407788/be86f07e-4b05-4c78-87bf-8738daf1ee20">
 </p>
 
-
 Code: [/runtimes/eoapi/raster](https://github.com/developmentseed/eoapi-devseed/tree/main/runtimes/eoapi/raster)
 
 ---
+
 ## eoapi.vector
 
 OGC Features and Tiles API built on top of [tipg](https://github.com/developmentseed/tipg).
 
-By default, the API will look for tables in the `public` schema of the database. We've also added three functions that connect to the pgSTAC schema:
+The API will look for tables in the database's `public` schema by default. We've also added three functions that connect to the pgSTAC schema:
 
 - **pg_temp.pgstac_collections_view**: Simple function which returns PgSTAC Collections
 - **pg_temp.pgstac_hash**: Return features for a specific `searchId` (hash)
 - **pg_temp.pgstac_hash_count**: Return the number of items per geometry for a specific `searchId` (hash)
 
 <p align="center">
-<img alt="eoapi.vector OpenAPI documentation" src="https://github.com/developmentseed/eoAPI/assets/10407788/80ff9659-bc07-4238-a94a-7cab0a2af380">
-<img alt="eoapi.vector landing page" src="https://github.com/developmentseed/eoAPI/assets/10407788/b2a8a8d4-d3a1-464a-8b1a-166499ee4abd">
+  <img alt="eoapi.vector OpenAPI documentation" src="https://github.com/developmentseed/eoAPI/assets/10407788/80ff9659-bc07-4238-a94a-7cab0a2af380">
+  <img alt="eoapi.vector landing page" src="https://github.com/developmentseed/eoAPI/assets/10407788/b2a8a8d4-d3a1-464a-8b1a-166499ee4abd">
 </p>
 
 Code: [/runtimes/eoapi/vector](https://github.com/developmentseed/eoapi-devseed/tree/main/runtimes/eoapi/vector)
 
---
+---
+
 # STAC browser
 
 The custom browser configuration can be modified using the config located in [/dockerfiles/browser_config.js](https://github.com/developmentseed/eoapi-devseed/blob/main/dockerfiles/browser_config.js). For more information about available configurations, see the [Radiant Earth repository](https://github.com/radiantearth/stac-browser).