Merge pull request #52 from eea/develop

Release
eea · Sep 29, 2023 · 50f78ce · 50f78ce
2 parents fbc69ba + b62f227
commit 50f78ce
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 19 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,12 @@ 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.1.6](https://github.com/eea/volto-slate-footnote/compare/6.1.5...6.1.6) - 29 September 2023
+
+#### :house: Documentation changes
+
+- docs: Update README and DEVELOP [Alin Voinea - [`982fcbc`](https://github.com/eea/volto-slate-footnote/commit/982fcbc29cf82b428532138f948d9038b021b149)]
+
 ### [6.1.5](https://github.com/eea/volto-slate-footnote/compare/6.1.4...6.1.5) - 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-slate-footnote/
+    yarn prepare
     ```
 
+1. Happy hacking!
+
 ### Or add @eeacms/volto-slate-footnote 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,10 +34,7 @@ Before starting make sure your development environment is properly set. See [Vol
 
 1.  Create new volto app
 
-        yo @plone/volto my-volto-project \
-                          --workspace src/addons/volto-slate-footnote \
-                          --addon @eeacms/volto-slate-footnote \
-                          --skip-install
+        yo @plone/volto my-volto-project --addon @eeacms/volto-slate-footnote --skip-install
         cd my-volto-project
 
 1.  Add the following to `mrs.developer.json`:
@@ -51,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
@@ -44,33 +44,32 @@ Go to http://localhost:3000
 
 1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone
 
-    ```Bash
-    docker compose up backend
-    ```
+   ```Bash
+   docker compose up backend
+   ```
 
 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-slate-footnote"
+       "@eeacms/volto-slate-footnote"
    ],
 
    "dependencies": {
-      "@eeacms/volto-slate-footnote": "*"
+       "@eeacms/volto-slate-footnote": "*"
    }
    ```
 
-1. If not, create one:
+* If not, create one:
 
    ```
    npm install -g yo @plone/generator-volto
    yo @plone/volto my-volto-project --canary --addon @eeacms/volto-slate-footnote
    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-slate-footnote",
-  "version": "6.1.5",
+  "version": "6.1.6",
   "description": "volto-slate-footnote: Volto add-on",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",