docs, ci: fixup README and CI

Author: gadomski

.github/workflows/cicd.yaml

@@ -46,6 +46,8 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
+          cache: pip
+          cache-dependency-path: setup.py
 
       - name: Lint code
         if: ${{ matrix.python-version == 3.8 }}
@@ -136,5 +138,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - name: Test generating docs
+      - name: Setup Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.10"
+          cache: pip
+          cache-dependency-path: setup.py
+      - name: Install with documentation dependencies
+        run: pip install .[docs,dev,server]
+      - name: Generate API docs
         run: make docs
+      - name: Build documentation
+        run: mkdocs build --strict

.github/workflows/packages.yml

@@ -12,10 +12,6 @@ jobs:
     permissions:
       contents: read
       packages: write
-    strategy:
-      fail-fast: true
-      matrix:
-        backend: ["sqlalchemy", "pgstac"]
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3
@@ -29,17 +25,12 @@ jobs:
         id: meta
         uses: docker/metadata-action@v4.3.0
         with:
-          images: ghcr.io/stac-utils/stac-fastapi
-          tags: |
-            type=schedule,suffix=-${{ matrix.backend }}
-            type=ref,event=branch,suffix=-${{ matrix.backend }}
-            type=ref,event=tag,suffix=-${{ matrix.backend }}
-            type=ref,event=pr,suffix=-${{ matrix.backend }}
+          images: ghcr.io/stac-utils/stac-fastapi-sqlalchemy
       - name: Build and push Docker image
         uses: docker/build-push-action@v4.0.0
         with:
           context: .
-          file: docker/Dockerfile.${{ matrix.backend }}
+          file: Dockerfile
           push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}

.github/workflows/deploy_mkdocs.yml renamed to .github/workflows/pages.yml

@@ -1,37 +1,34 @@
-name: Publish docs via GitHub Pages
-
+name: Deploy static content to Pages
 on:
   push:
     branches:
       - main
-    paths:
-      # Rebuild website when docs have changed or code has changed
-      - "README.md"
-      - "docs/**"
-      - "mkdocs.yml"
-      - "**.py"
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
 
 jobs:
   build:
     name: Deploy docs
     runs-on: ubuntu-latest
-
     steps:
       - name: Checkout main
         uses: actions/checkout@v3
-
-      - name: Set up Python 3.8
+      - name: Set up Python 3.10
         uses: actions/setup-python@v4
         with:
-          python-version: 3.8
-
+          python-version: "3.10"
+          cache: pip
+          cache-dependency-path: setup.py
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install -e .
-          python -m pip install mkdocs mkdocs-material pdocs
-
-      - name: update API docs
+          python -m pip install .[docs]
+      - name: Update API docs
         run: |
           pdocs as_markdown \
             --output_dir docs/api/ \
@@ -46,6 +43,12 @@ jobs:
           POSTGRES_PORT: 5432
           POSTGRES_HOST_READER: localhost
           POSTGRES_HOST_WRITER: localhost
-
-      - name: Deploy docs
-        run: mkdocs gh-deploy --force
+      - name: Build docs
+        run: mkdocs build --site-dir site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: site
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

README.md

@@ -1,3 +1,57 @@
-# Requirements
+# stac-fastapi-sqlalchemy
 
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/stac-utils/stac-fastapi-sqlalchemy/cicd.yaml?style=for-the-badge)](https://github.com/stac-utils/stac-fastapi-sqlalchemy/actions/workflows/cicd.yaml)
+[![PyPI](https://img.shields.io/pypi/v/stac-fastapi.sqlalchemy?style=for-the-badge)](https://pypi.org/project/stac-fastapi.sqlalchemy)
+[![Documentation](https://img.shields.io/github/actions/workflow/status/stac-utils/stac-fastapi-sqlalchemy/pages.yml?label=Docs&style=for-the-badge)](https://stac-utils.github.io/stac-fastapi-sqlalchemy/)
+[![License](https://img.shields.io/github/license/stac-utils/stac-fastapi-sqlalchemy?style=for-the-badge)](https://github.com/stac-utils/stac-fastapi-sqlalchemy/blob/main/LICENSE)
+
+[SQLAlchemy](https://www.sqlalchemy.org/) backend for [stac-fastapi](https://github.com/stac-utils/stac-fastapi), the [FastAPI](https://fastapi.tiangolo.com/) implementation of the [STAC API spec](https://github.com/radiantearth/stac-api-spec)
 The SQLAlchemy backend requires **PostGIS>=3**.
+
+## Overview
+
+**stac-fastapi-sqlalchemy** is an HTTP interface built in FastAPI.
+
+## Contributing
+
+See [CONTRIBUTING](https://github.com/stac-utils/stac-fastapi-sqlalchemy/blob/main/CONTRIBUTING.md) for detailed contribution instructions.
+
+To install:
+
+```shell
+git clone https://github.com/stac-utils/stac-fastapi-sqlalchemy
+cd stac-fastapi-sqlalchemy
+pip install -e ".[dev,server,docs]"
+```
+
+To test:
+
+```shell
+make test
+```
+
+Use Github [Pull Requests](https://github.com/stac-utils/stac-fastapi-sqlalchemy/pulls) to provide new features or to request review of draft code, and use [Issues](https://github.com/stac-utils/stac-fastapi-sqlalchemy/issues) to report bugs or request new features.
+
+### Documentation
+
+To build the docs:
+
+```shell
+make docs
+```
+
+Then, serve the docs via a local HTTP server:
+
+```shell
+mkdocs serve
+```
+
+## History
+
+In April of 2023, it was removed from the core **stac-fastapi** repository and moved to its current location (<http://github.com/stac-util/stac-fastapi-sqlalchemy>).
+
+## License
+
+[MIT](https://github.com/stac-utils/stac-fastapi-sqlalchemy/blob/main/LICENSE)
+
+<!-- markdownlint-disable-file MD033 -->