[docs] add CHANGELOG.md and link within sphinx docs, bump to samgis version 1.1.0

README.md

@@ -124,3 +124,7 @@ cd docs && make clean html && cd ../
 ```
 
 The static documentation it's now ready at the path `docs/_build/html/index.html`.
+ 
+To create a work in progress openapi json or yaml file use
+- `extract-openapi-fastapi.py`
+- `extract-openapi-lambda.py` (useful to export the json schema request and response from lambda app api)

docs/Changelog.md

@@ -0,0 +1,27 @@
+# Changelog
+
+## Version 1.1.0
+- Added this changelog
+- specific backend branch code uses terrain providers like nextzen and MapBox Terrain-RGB v1
+- update test coverage
+- update python dependencies versions
+- update node dependencies versions
+
+## Version 1.0.2
+- HuggingFace frontend demo: update the navbar url to SamGIS docs
+- add two openapi docs builder scripts
+- update samgis version within docs
+- remove unused package.json
+
+## Version 1.0.1
+- fixed zlib1g security vulnerability in python:3.11-slim-bookworm docker image, see https://security-tracker.debian.org/tracker/CVE-2023-45853
+
+## Version 1.0.0
+First release:
+- user onboarding tour with driver.js
+- code decoupling between the AWS lambda wrapper and the backend...
+- ...now also deployed on this HuggingSpace space demo (here some explanation about adding a SPA vuejs frontend)
+- request input validation using Pydantic
+- support for array prompts (both rectangle and point types)
+- tiles download/merge/crop steps uses contextily by geopandas
+- CSS frontend style with Tailwind

docs/conf.py

@@ -11,7 +11,7 @@ import sys
 project = 'SamGIS'
 copyright = '2023-2024, alessandro trinca tornidor'
 author = 'alessandro trinca tornidor'
-release = '1.0.2'
+release = '1.1.0'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

docs/index.rst

@@ -8,6 +8,8 @@ Welcome to SamGIS's documentation!
 
 .. include:: brief_project_presentation.md
    :parser: myst_parser.sphinx_
+.. include:: Changelog.md
+   :parser: myst_parser.sphinx_
 
 .. toctree::
    :maxdepth: 2

docs/specs/openapi.yaml

@@ -12,7 +12,7 @@ info:
   license:
     name: MIT License
     url: https://opensource.org/license/mit/
-  version: "1.0.2"
+  version: "1.1.0"
 servers:
   - url: https://localhost:8000/
 tags:

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "samgis"
-version = "1.0.2"
+version = "1.1.0"
 description = "A backend for machine learning instance segmentation on geospatial data even without dedicated graphics cards."
 authors = ["alessandro trinca tornidor <[email protected]>"]
 license = "MIT license"