Merge pull request #157 from gtt-project/ftr/release

Prepares 4.1 release

Author: dkastl

README.md

@@ -26,14 +26,14 @@ Redmine GTT plugins **require PostgreSQL/PostGIS** and will not work with SQLite
 
 Create a PostGIS-enabled database:
 
-```
+```sh
 createdb -U postgres -O redmine redmine
 psql -U postgres -d redmine -c "CREATE EXTENSION postgis;"
 ```
 
 To install Redmine GTT plugin, download or clone this repository in your Redmine installation plugins directory!
 
-```
+```sh
 cd path/to/plugin/directory
 git clone https://github.com/gtt-project/redmine_gtt.git
 cd redmine_gtt
@@ -43,7 +43,7 @@ npx webpack
 
 Then run
 
-```
+```sh
 export GEM_PG_VERSION=your-pg-version # skip this line if redmine use pg 1.2.2.
 export GEM_RGEO_ACTIVERECORD_VERSION=your-rgeo-activerecord-version # skip this line if using rgeo-activerecord 6.2.2.
 export GEM_ACTIVERECORD_POSTGIS_ADAPTER_VERSION=your-activerecord-postgis-adapter-version # skip this line if using activerecord-postgis-adapter 5.2.3.
@@ -55,9 +55,8 @@ Before restarting Redmine, you need to set `postgis` adapter instead of `postgre
 
 After restarting Redmine, you should be able to see the Redmine GTT plugin in the Plugins page.
 
-More information on installing (and uninstalling) Redmine plugins can be found here: http://www.redmine.org/wiki/redmine/Plugins
-## API
-[Redmine GTT API](doc/api.md)
+More information on installing (and uninstalling) Redmine plugins can be found in the [Redmine Plugin docs](http://www.redmine.org/wiki/redmine/Plugins).
+
 ## How to use
 
 1. Go to plugin configuration for global settings
@@ -68,6 +67,10 @@ More information on installing (and uninstalling) Redmine plugins can be found h
 
 For more information with screenshots see the [Getting Started](doc/getting-started.md) guide.
 
+## Plugin API
+
+For more information see the [Redmine GTT API](doc/api.md) docs.
+
 ## Contributing and Support
 
 The GTT Project appreciates any [contributions](https://github.com/gtt-project/.github/blob/main/CONTRIBUTING.md)! Feel free to contact us for [reporting problems and support](https://github.com/gtt-project/.github/blob/main/CONTRIBUTING.md).
@@ -76,15 +79,15 @@ The GTT Project appreciates any [contributions](https://github.com/gtt-project/.
 
 You can debug frontend by running the following command on another console:
 
-```
+```sh
 npx webpack --watch --mode=development
 ```
 
 ### How to run test
 
 You can run the plugin test on rails test environment by the following command:
 
-```
+```sh
 bundle exec rake db:create
 RAILS_ENV=test bundle exec rake db:migrate
 RAILS_ENV=test bundle exec rake redmine:plugins:migrate
@@ -93,8 +96,7 @@ RAILS_ENV=test NAME=redmine_gtt bundle exec rake redmine:plugins:test
 
 ## Version History
 
-- **4.0.0**: Support Redmine >= 5.0 and drop Redmine <= 4.1 support
-- See [all releases](https://github.com/gtt-project/redmine_gtt/releases) with release notes.
+See [all releases](https://github.com/gtt-project/redmine_gtt/releases) with release notes.
 
 ## Authors
 

doc/api.md

@@ -1,31 +1,36 @@
 # GTT API
 
 ## Global Level API Endpoint
-### API Endpoint
-```
+
+### Plugin settings API Endpoint
+
+```text
 GET /gtt/settings.json
 ```
+
 Get all the GTT default settings and also all the global GTT layers data.
 
 ***Request***
-```
+
+```text
 http://localhost:3000/gtt/settings.json
 ```
 
 ***Response***
+
 ```json
 {
     "gttDefaultSetting": {
         "defaultTrackerIcon": [
             {
-                "trackerID": "1",
+                "trackerID": 1,
                 "trackerName": "Task",
                 "icon": "maki-square"
             },
         ],
         "defaultStatusColor": [
             {
-                "statusID": "1",
+                "statusID": 1,
                 "statusName": "New",
                 "color": "#00ff00"
             },
@@ -40,10 +45,10 @@ http://localhost:3000/gtt/settings.json
                 "LineString",
                 "Polygon"
             ],
-            "GeoJsonUpload": null
+            "GeoJsonUpload": false
         },
         "geocoderSetting": {
-            "enableGeocodingOnMap": "true",
+            "enableGeocodingOnMap": true,
             "geocoderOptions": "{}"
         }
     },
@@ -61,7 +66,7 @@ http://localhost:3000/gtt/settings.json
       },
       {
          "id": 2,
-         "name": "GIS Satellite Map",
+         "name": "Satellite Map",
          "type": "ol.source.XYZ",
          "options": {
              "url": "https://cyberjapandata.gsi.go.jp/xyz/seamlessphoto/{z}/{x}/{y}.jpg",
@@ -75,23 +80,29 @@ http://localhost:3000/gtt/settings.json
 ```
 
 ## Project Level API Endpoint
-### API Endpoint
-```
+
+### Project settings API Endpoint
+
+```text
 GET /projects/{project_identifier}.json
 ```
+
 Get project and selected GTT layer data of a specific project.
 
 ***Request***
-```
+
+```text
 http://localhost:3000/projects/1.json
 ```
+
 ***Response***
+
 ```json
 {
     "project": {
         "id": 1,
-        "name": "first testing project ",
-        "identifier": "first-testing-project",
+        "name": "My Project ",
+        "identifier": "my-project",
         "description": "",
         "homepage": "",
         "status": 1,
@@ -121,4 +132,3 @@ http://localhost:3000/projects/1.json
     }
 }
 ```
-

init.rb

@@ -8,7 +8,7 @@
   author_url 'https://github.com/georepublic'
   url 'https://github.com/gtt-project/redmine_gtt'
   description 'Adds location-based task management and maps'
-  version '4.0.0'
+  version '4.1.0'
 
   requires_redmine :version_or_higher => '4.2.0'