@eeacms/volto-eea-design-system 1.18.2 → 1.18.3

package/CHANGELOG.md

@@ -4,6 +4,13 @@ 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).
 
+### [1.18.3](https://github.com/eea/volto-eea-design-system/compare/1.18.2...1.18.3) - 29 September 2023
+
+#### :house: Documentation changes
+
+- docs: Update README and DEVELOP [Alin Voinea - [`efbc670`](https://github.com/eea/volto-eea-design-system/commit/efbc67072601e42203ea6314fb65ebe16df64954)]
+- docs: Update README and DEVELOP [Alin Voinea - [`d3b4ba8`](https://github.com/eea/volto-eea-design-system/commit/d3b4ba83a045e0fc51642b07e029c7a4f2ea8f5d)]
+
 ### [1.18.2](https://github.com/eea/volto-eea-design-system/compare/1.18.1...1.18.2) - 25 September 2023
 
 #### :bug: Bug Fixes

package/DEVELOP.md

@@ -16,12 +16,14 @@
 
 1. Go to http://localhost:3000
 
-1.  Happy hacking!
+1. Initialize git hooks
 
     ```Bash
-    cd src/addons/volto-eea-design-system/
+    yarn prepare
     ```
 
+1. Happy hacking!
+
 ### Or add @eeacms/volto-eea-design-system 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/)
@@ -48,18 +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 pull plone
-        docker run -d --name plone -p 8080:8080 -e SITE=Plone -e PROFILES="profile-plone.restapi:blocks" 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

package/README.md

@@ -25,6 +25,19 @@ This package provides the following features:
 2. A repository for the design system source files and mockups
 3. A website to showcase the design system
 
+### Try the design system website
+
+Checkout the docs found within the [website](https://github.com/eea/volto-eea-design-system/blob/develop/website/README.md) folder
+
+### Try the design system mockups
+
+Checkout the docs found within the [mockups](https://github.com/eea/volto-eea-design-system/blob/develop/mockups/README.md) folder
+
+## Docusaurus and Storybook
+
+See [Docusaurus](https://eea.github.io/).
+See [Storybook](https://eea.github.io/eea-storybook/).
+
 ## Getting started
 
 ### Try volto-eea-design-system with Docker
@@ -46,64 +59,51 @@ Go to http://localhost:3000
 
 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-eea-design-system"
-  ],
+   ```JSON
+   "addons": [
+       "@eeacms/volto-eea-design-system"
+   ],
 
-  "dependencies": {
-      "@eeacms/volto-eea-design-system": "^1.0.0"
-  }
-  ```
+   "dependencies": {
+       "@eeacms/volto-eea-design-system": "*"
+   }
+   ```
 
-- If not, create one:
+* If not, create one:
 
-  ```
-  npm install -g yo @plone/generator-volto
-  yo @plone/volto my-volto-project --addon @eeacms/volto-eea-design-system
-  cd my-volto-project
-  ```
+   ```
+   npm install -g yo @plone/generator-volto
+   yo @plone/volto my-volto-project --canary --addon @eeacms/volto-eea-design-system
+   cd my-volto-project
+   ```
 
-1. Install the new add-ons by updating `package.json` and restart Volto:
+1. Install new add-ons and restart Volto:
 
    ```
    yarn
    yarn start
    ```
 
-2. Go to http://localhost:3000
-
-3. Happy editing!
-
-### Try the design system website
-
-Checkout the docs found within the [website](https://github.com/eea/volto-eea-design-system/blob/develop/website/README.md) folder
-
-### Try the design system mockups
+1. Go to http://localhost:3000
 
-Checkout the docs found within the [mockups](https://github.com/eea/volto-eea-design-system/blob/develop/mockups/README.md) folder
+1. Happy editing!
 
 ## Release
 
 See [RELEASE.md](https://github.com/eea/volto-eea-design-system/blob/master/RELEASE.md).
 
-## Docusaurus and Storybook
-
-See [Docusaurus](https://eea.github.io/).
-See [Storybook](https://eea.github.io/eea-storybook/).
-
 ## How to contribute
 
-See [DEVELOP.md](https://github.com/eea/volto-eea-design-system/blob/develop/DEVELOP.md).
+See [DEVELOP.md](https://github.com/eea/volto-eea-design-system/blob/master/DEVELOP.md).
 
 ## Copyright and license
 
 The Initial Owner of the Original Code is European Environment Agency (EEA).
 All Rights Reserved.
 
-See [LICENSE.md](https://github.com/eea/volto-eea-design-system/blob/develop/LICENSE.md) for details.
+See [LICENSE.md](https://github.com/eea/volto-eea-design-system/blob/master/LICENSE.md) for details.
 
 ## Funding
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eeacms/volto-eea-design-system",
-  "version": "1.18.2",
+  "version": "1.18.3",
   "description": "@eeacms/volto-eea-design-system: Volto add-on",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",