Merge pull request #42 from eea/develop

Release
eea · Sep 29, 2023 · 9bba1c5 · 9bba1c5
2 parents def8901 + 09a9651
commit 9bba1c5
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 48 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,14 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
-### [6.3.1](https://github.com/eea/volto-group-block/compare/6.3.0...6.3.1) - 18 September 2023
+### [6.3.2](https://github.com/eea/volto-group-block/compare/6.3.1...6.3.2) - 29 September 2023
+
+#### :house: Documentation changes
+
+- docs: Update README and DEVELOP [Alin Voinea - [`fcad0c8`](https://github.com/eea/volto-group-block/commit/fcad0c8303aa1807d1cc7fda1477951a22032b0b)]
+- docs: Update DEVELOP [Alin Voinea - [`13ab983`](https://github.com/eea/volto-group-block/commit/13ab983ea94a1032a8ae20cd7dc2bb4fff3dd224)]
+
+### [6.3.1](https://github.com/eea/volto-group-block/compare/6.3.0...6.3.1) - 19 September 2023
 
 #### :bug: Bug Fixes
 

diff --git a/DEVELOP.md b/DEVELOP.md
@@ -16,12 +16,14 @@
 
 1. Go to http://localhost:3000
 
-1.  Happy hacking!
+1. Initialize git hooks
 
     ```Bash
-    cd src/addons/volto-group-block/
+    yarn prepare
     ```
 
+1. Happy hacking!
+
 ### Or add @eeacms/volto-group-block to your Volto project
 
 Before starting make sure your development environment is properly set. See [Volto Developer Documentation](https://docs.voltocms.com/getting-started/install/)
@@ -32,8 +34,8 @@ Before starting make sure your development environment is properly set. See [Vol
 
 1.  Create new volto app
 
-        yo @plone/volto my-dev-project --addon @eeacms/volto-group-block --skip-install
-        cd my-dev-project
+        yo @plone/volto my-volto-project --addon @eeacms/volto-group-block --skip-install
+        cd my-volto-project
 
 1.  Add the following to `mrs.developer.json`:
 
@@ -48,17 +50,15 @@ Before starting make sure your development environment is properly set. See [Vol
 
 1.  Install
 
-        yarn develop
+        make develop
         yarn
 
 1.  Start backend
 
-        docker run -d --name plone -p 8080:8080 -e SITE=Plone plone
+        docker run --pull always -it --rm --name plone -p 8080:8080 -e SITE=Plone plone/plone-backend
 
     ...wait for backend to setup and start - `Ready to handle requests`:
 
-        docker logs -f plone
-
     ...you can also check http://localhost:8080/Plone
 
 1.  Start frontend

diff --git a/README.md b/README.md
@@ -20,32 +20,16 @@
 
 ![Group blocks and restrict available blocks](https://github.com/eea/volto-group-block/raw/docs/docs/volto-group-block.gif)
 
-### Try volto-group-block with Docker
-
-1. Get the latest Docker images
-
-   ```
-   docker pull plone
-   docker pull plone/volto
-   ```
+## Getting started
 
-1. Start Plone backend
-
-   ```
-   docker run -d --name plone -p 8080:8080 -e SITE=Plone -e PROFILES="profile-plone.restapi:blocks" plone
-   ```
-
-1. Start Volto frontend
-
-   ```
-   docker run -it --rm -p 3000:3000 --link plone -e ADDONS="@eeacms/volto-group-block" plone/volto
-   ```
-
-1. Go to http://localhost:3000
+### Try volto-group-block with Docker
 
-1. Login with **admin:admin**
+      git clone https://github.com/eea/volto-group-block.git
+      cd volto-group-block
+      make
+      make start
 
-1. Create a new **Page** and add a new **Section (Group)** block.
+Go to http://localhost:3000
 
 ### Add volto-group-block to your Volto project
 
@@ -57,25 +41,25 @@
 
 1. Start Volto frontend
 
-- If you already have a volto project, just update `package.json`:
+* If you already have a volto project, just update `package.json`:
 
-  ```JSON
-  "addons": [
-      "@eeacms/volto-group-block"
-  ],
+   ```JSON
+   "addons": [
+       "@eeacms/volto-group-block"
+   ],
 
-  "dependencies": {
-      "@eeacms/volto-group-block": "^4.0.0"
-  }
-  ```
+   "dependencies": {
+       "@eeacms/volto-group-block": "*"
+   }
+   ```
 
-- If not, create one:
+* If not, create one:
 
-  ```
-  npm install -g yo @plone/generator-volto
-  yo @plone/volto my-volto-project --addon @eeacms/volto-group-block
-  cd my-volto-project
-  ```
+   ```
+   npm install -g yo @plone/generator-volto
+   yo @plone/volto my-volto-project --canary --addon @eeacms/volto-group-block
+   cd my-volto-project
+   ```
 
 1. Install new add-ons and restart Volto:
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eeacms/volto-group-block",
-  "version": "6.3.1",
+  "version": "6.3.2",
   "description": "volto-group-block: Volto block to be used to group other blocks",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",