AAE-12770 add markdown formatting (#4292)

* AAE-12770: setup markdown formatting with prettier

* AAE-12770: update pre-commit configuration

* sync editorconfig in IDE configuration folder

.editorconfig

@@ -14,7 +14,6 @@ indent_size = 4
 
 [*.md]
 max_line_length = off
-trim_trailing_whitespace = false
 
 [Makefile]
 indent_style = tab

.pre-commit-config.yaml

 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.1.0
+    rev: v4.4.0
     hooks:
       - id: check-json
       - id: check-yaml
@@ -12,12 +12,15 @@ repos:
         args: ['--fix=lf']
       - id: end-of-file-fixer
       - id: trailing-whitespace
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v3.0.0-alpha.6
+    hooks:
+      - id: prettier
+        types_or:
+          - markdown
   - repo: https://github.com/sirosen/check-jsonschema
-    rev: 0.17.0
+    rev: 0.22.0
     hooks:
+      - id: check-dependabot
+      - id: check-github-actions
       - id: check-github-workflows
-      - id: check-jsonschema
-        alias: check-dependabot
-        name: "Validate Dependabot Config"
-        files: '.github/dependabot\.yml$'
-        args: ["--schemafile", "https://json.schemastore.org/dependabot-2.0.json"]

CODE_OF_CONDUCT.md

@@ -8,19 +8,19 @@ In the interest of fostering an open and welcoming environment, we as contributo
 
 Examples of behavior that contributes to creating a positive environment include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
 
 ## Our Responsibilities
 

CONTRIBUTING.md

 If you want to contribute get in touch with the project members and ask for guidance.
 This project is a community driven project, so get in touch if you want to participate.
 
-Unit tests
---------------------
+## Unit tests
+
 Activiti uses now [AssertJ](http://joel-costigliola.github.io/assertj/assertj-core-features-highlight.html)
 as alternative to default JUnit assertions. This makes tests more readable and provides clearer failure messages.
 Please, make sure that you are using `AssertJ` assertions for every new test.
 I.e.
-* `assertThat(myBoolean).isTrue();` instead of `assertTrue(myBoolean);`
-* `assertThat(actual).isEqualTo(expected);` instead of `assertEquals(expected, actual);`
-* `assertThat(myList).containsExactly("a", "b", "c");` instead of `assertTrue(myList.contains("a", "b", "c"));`
 
-Branches naming convention
---------------------------
+- `assertThat(myBoolean).isTrue();` instead of `assertTrue(myBoolean);`
+- `assertThat(actual).isEqualTo(expected);` instead of `assertEquals(expected, actual);`
+- `assertThat(myList).containsExactly("a", "b", "c");` instead of `assertTrue(myList.contains("a", "b", "c"));`
+
+## Branches naming convention
+
 If you are creating branches directly in the [main repository](https://github.com/Activiti/Activiti), this is
- the naming convention to be used for branches:
- - `username-issueNumber-anythingYouWant`
+the naming convention to be used for branches:
+
+- `username-issueNumber-anythingYouWant`

README.md

-Activiti
-========
+# Activiti
 
 [![Join Us in Gitter](https://badges.gitter.im/Activiti/Activiti7.svg)](https://gitter.im/Activiti/Activiti7?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![CI](https://github.com/Activiti/Activiti/actions/workflows/main.yml/badge.svg)](https://github.com/Activiti/Activiti/actions/workflows/main.yml)
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/8035801ae94c441981f363fa99824a33)](https://www.codacy.com/gh/Activiti/Activiti?utm_source=github.com&utm_medium=referral&utm_content=Activiti/Activiti&utm_campaign=Badge_Grade)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/8035801ae94c441981f363fa99824a33)](https://www.codacy.com/gh/Activiti/Activiti?utm_source=github.com&utm_medium=referral&utm_content=Activiti/Activiti&utm_campaign=Badge_Grade)
 [![ASL 2.0](https://img.shields.io/hexpm/l/plug.svg)](https://github.com/Activiti/Activiti/blob/develop/LICENSE.txt)
 [![CLA](https://cla-assistant.io/readme/badge/Activiti/Activiti)](https://cla-assistant.io/Activiti/Activiti)
 [![security status](https://www.meterian.io/badge/gh/Activiti/Activiti/security)](https://www.meterian.io/report/gh/Activiti/Activiti)
@@ -12,96 +11,103 @@ Activiti
 
 Homepage: <http://activiti.org>
 
-
 Activiti is a light-weight workflow and Business Process Management (BPM) Platform targeted at business people, developers and system admins. Its core is a super-fast and rock-solid BPMN 2 process engine for Java. It's open-source and distributed under the Apache license. Activiti runs in any Java application, on a server, on a cluster or in the cloud. It integrates perfectly with Spring, it is extremely lightweight and based on simple concepts.
 
-**__NOTE: We moved to the master branch all the content of the development branch that we were using to design and code the next major version of the project. If you want to contribute with version 6.x please look at the 6.x branch.__**
+\***\*NOTE: We moved to the master branch all the content of the development branch that we were using to design and code the next major version of the project. If you want to contribute with version 6.x please look at the 6.x branch.\*\***
 
 If you want to read more about our Repositories structure you can read our [GitBook](https://activiti.gitbooks.io/activiti-7-developers-guide/content/).
 
-Configuring IntelliJ
---------------------
-
-* Force language level 11, to fail-fast when (accidentally) using features available only in newer Java versions.
-    * Open menu *File*, menu item *Project Structure*
-    * Click list item *Modules*, for each module, tab *Sources*, combobox *Language level* should be automatically set to `11 ...`
-
-* Avoid that changes in some resources are ignored in the next run/debug (and you are forced to use mvn)
-    * Open menu *File*, menu item *Settings* or menu *IntelliJ IDEA*, menu item *Preferences...* if on a Mac
-    * Click tree item *Compiler*, textfield *Resource patterns*: change to `!?*.java` (remove other content)
-
-* Avoid a `StackOverflowError` when building
-    * Open menu *File*, menu item *Settings* or menu *IntelliJ IDEA*, menu item *Preferences...* if on a Mac
-    * Click tree item *Compiler*, tree item *Java Compiler*, textfield *Additional command line parameters*
-    * Add `-J-Xss1024k`
-
-* Recommended code style: use the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html) with editorconfig
-    * Download the IntelliJ code style xml from: [https://google.github.io/styleguide/intellij-java-google-style.xml]
-    * Open menu *File*, menu item *Settings* or menu *IntelliJ IDEA*, menu item *Preferences...* if on a Mac
-    * Click tree item *Code Style*, click cogwheel and select *Import scheme*, then *IntelliJ code style xml*
-    * Browse where you downloaded the xml and open it. Check that GoogleStyle is the active scheme.
-        * Note: IntelliJ IDEA doesn't format your code automatically. You have to press Ctrl+Alt+L keyboard combination to trigger auto formatting when coding is done.
-    * There's an `.editorconfig` what has definition for indents, file encoding, line endings.
-    * If you disable it, you need to set the file encoding and number of spaces correctly manually.
-    * Eclipse code style xml: [https://google.github.io/styleguide/eclipse-java-google-style.xml]
-    * Eclipse needs [editorconfig-eclipse](https://marketplace.eclipse.org/content/editorconfig-eclipse) plugin in order to support EditorConfig files.
-
-* Set manually the correct file encoding (UTF-8 except for properties files) and end-of-line characters (unix):
-    * Open menu *File*, menu item *Settings* or menu *IntelliJ IDEA*, menu item *Preferences...* if on a Mac
-    * Click tree item *Code Style*, tree item *General*
-        * Combobox *Line separator (for new files)*: `Unix`
-    * Click tree item *File Encodings*
-        * Combobox *IDE Encoding*: `UTF-8`
-        * Combobox *Default encoding for properties files*: `ISO-8859-1`
-            * Note: normal i18n properties files must be in `ISO-8859-1` as specified by the java `ResourceBundle` contract.
-
-* Set manually the correct number of spaces when pressing tab:
-    * Open menu *File*, menu item *Settings* or menu *IntelliJ IDEA*, menu item *Preferences...* if on a Mac
-    * Click tree item *Code Style*, tree item *General*
-    * Click tab *Java*
-        * Checkbox *Use tab character*: `off`
-        * Textfield *Tab size*: `4`
-        * Textfield *Indent*: `4`
-        * Textfield *Continuation indent*: `8`
-    * Open tab *XML*
-        * Checkbox *Use tab character*: `off`
-        * Textfield *Tab size*: `2`
-        * Textfield *Indent*: `2`
-        * Textfield *Continuation indent*: `4`
-
-* Set the correct file headers (do not include @author or a meaningless javadoc):
-    * Open menu *File*, menu item *Settings* or menu *IntelliJ IDEA*, menu item *Preferences...* if on a Mac
-    * Click tree item *File templates*, tab *Includes*, list item `File Header`
-    * Remove the line *@author Your Name*.
-        * We do not accept `@author` lines in source files, see FAQ below.
-    * Remove the entire javadoc as automatically templated data is meaningless.
-
-* Set the correct license header
-    * Open menu *File*, menu item *Settings* or menu *IntelliJ IDEA*, menu item *Preferences...* if on a Mac
-    * Click tree item *Copyright*, tree item *Copyright profiles*
-        * Click import button to import the *Copyright profile*
-        * Select the file: [Alfresco_Software.xml](./ide-configuration/intellij-configuration/copyright/Alfresco_Software.xml)
-    * Click tree item *Copyright*
-        * Combobox *Default project copyright*: `Alfresco Software`
-
-FAQ
-===
-
-* Why do you not accept `@author` lines in your source code?
-    * Because the author tags in the java files are a maintenance nightmare
-        * A large percentage is wrong, incomplete or inaccurate.
-        * Most of the time, it only contains the original author. Many files are completely refactored/expanded by other authors.
-        * Git is accurate, that is the canonical source to find the correct author.
-
-    * Because the author tags promote *code ownership*, which is bad in the long run.
-        * If people work on a piece they perceive as being owned by someone else, they tend to:
-            * only fix what they are assigned to fix, instead of everything that's broken
-            * discard responsibility if that code doesn't work properly
-            * be scared of stepping on the feet of the owner.
-
-    * Credit to the authors is given:
-        * with [Open Hub](https://www.openhub.net/p/activiti/contributors) which also has statistics
-        * in [the GitHub web interface](https://github.com/activiti).
+## Configuring IntelliJ
+
+- Force language level 11, to fail-fast when (accidentally) using features available only in newer Java versions.
+
+  - Open menu _File_, menu item _Project Structure_
+  - Click list item _Modules_, for each module, tab _Sources_, combobox _Language level_ should be automatically set to `11 ...`
+
+- Avoid that changes in some resources are ignored in the next run/debug (and you are forced to use mvn)
+
+  - Open menu _File_, menu item _Settings_ or menu _IntelliJ IDEA_, menu item _Preferences..._ if on a Mac
+  - Click tree item _Compiler_, textfield _Resource patterns_: change to `!?*.java` (remove other content)
+
+- Avoid a `StackOverflowError` when building
+
+  - Open menu _File_, menu item _Settings_ or menu _IntelliJ IDEA_, menu item _Preferences..._ if on a Mac
+  - Click tree item _Compiler_, tree item _Java Compiler_, textfield _Additional command line parameters_
+  - Add `-J-Xss1024k`
+
+- Recommended code style: use the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html) with editorconfig
+
+  - Download the IntelliJ code style xml from: [https://google.github.io/styleguide/intellij-java-google-style.xml]
+  - Open menu _File_, menu item _Settings_ or menu _IntelliJ IDEA_, menu item _Preferences..._ if on a Mac
+  - Click tree item _Code Style_, click cogwheel and select _Import scheme_, then _IntelliJ code style xml_
+  - Browse where you downloaded the xml and open it. Check that GoogleStyle is the active scheme.
+    - Note: IntelliJ IDEA doesn't format your code automatically. You have to press Ctrl+Alt+L keyboard combination to trigger auto formatting when coding is done.
+  - There's an `.editorconfig` what has definition for indents, file encoding, line endings.
+  - If you disable it, you need to set the file encoding and number of spaces correctly manually.
+  - Eclipse code style xml: [https://google.github.io/styleguide/eclipse-java-google-style.xml]
+  - Eclipse needs [editorconfig-eclipse](https://marketplace.eclipse.org/content/editorconfig-eclipse) plugin in order to support EditorConfig files.
+
+- Set manually the correct file encoding (UTF-8 except for properties files) and end-of-line characters (unix):
+
+  - Open menu _File_, menu item _Settings_ or menu _IntelliJ IDEA_, menu item _Preferences..._ if on a Mac
+  - Click tree item _Code Style_, tree item _General_
+    - Combobox _Line separator (for new files)_: `Unix`
+  - Click tree item _File Encodings_
+    - Combobox _IDE Encoding_: `UTF-8`
+    - Combobox _Default encoding for properties files_: `ISO-8859-1`
+      - Note: normal i18n properties files must be in `ISO-8859-1` as specified by the java `ResourceBundle` contract.
+
+- Set manually the correct number of spaces when pressing tab:
+
+  - Open menu _File_, menu item _Settings_ or menu _IntelliJ IDEA_, menu item _Preferences..._ if on a Mac
+  - Click tree item _Code Style_, tree item _General_
+  - Click tab _Java_
+    - Checkbox _Use tab character_: `off`
+    - Textfield _Tab size_: `4`
+    - Textfield _Indent_: `4`
+    - Textfield _Continuation indent_: `8`
+  - Open tab _XML_
+    - Checkbox _Use tab character_: `off`
+    - Textfield _Tab size_: `2`
+    - Textfield _Indent_: `2`
+    - Textfield _Continuation indent_: `4`
+
+- Set the correct file headers (do not include @author or a meaningless javadoc):
+
+  - Open menu _File_, menu item _Settings_ or menu _IntelliJ IDEA_, menu item _Preferences..._ if on a Mac
+  - Click tree item _File templates_, tab _Includes_, list item `File Header`
+  - Remove the line _@author Your Name_.
+    - We do not accept `@author` lines in source files, see FAQ below.
+  - Remove the entire javadoc as automatically templated data is meaningless.
+
+- Set the correct license header
+  - Open menu _File_, menu item _Settings_ or menu _IntelliJ IDEA_, menu item _Preferences..._ if on a Mac
+  - Click tree item _Copyright_, tree item _Copyright profiles_
+    - Click import button to import the _Copyright profile_
+    - Select the file: [Alfresco_Software.xml](./ide-configuration/intellij-configuration/copyright/Alfresco_Software.xml)
+  - Click tree item _Copyright_
+    - Combobox _Default project copyright_: `Alfresco Software`
+
+# FAQ
+
+- Why do you not accept `@author` lines in your source code?
+
+  - Because the author tags in the java files are a maintenance nightmare
+
+    - A large percentage is wrong, incomplete or inaccurate.
+    - Most of the time, it only contains the original author. Many files are completely refactored/expanded by other authors.
+    - Git is accurate, that is the canonical source to find the correct author.
+
+  - Because the author tags promote _code ownership_, which is bad in the long run.
+
+    - If people work on a piece they perceive as being owned by someone else, they tend to:
+      - only fix what they are assigned to fix, instead of everything that's broken
+      - discard responsibility if that code doesn't work properly
+      - be scared of stepping on the feet of the owner.
+
+  - Credit to the authors is given:
+    - with [Open Hub](https://www.openhub.net/p/activiti/contributors) which also has statistics
+    - in [the GitHub web interface](https://github.com/activiti).
 
 # Development commands
 
@@ -135,8 +141,8 @@ the site will be generated at: `target/staging/index.html`
 
 Running on [GitHub Actions](https://github.com/features/actions), requires the following secrets to be set:
 
-| Name | Description |
-|------|-------------|
+| Name           | Description                        |
+| -------------- | ---------------------------------- |
 | NEXUS_USERNAME | Internal Maven repository username |
 | NEXUS_PASSWORD | Internal Maven repository password |
-| GITHUB_TOKEN | GitHub token |
+| GITHUB_TOKEN   | GitHub token                       |

activiti-api/README.md

 # activiti-api
+
 Activiti Frameworks API layer

activiti-core-common/README.md

 # activiti-core-common
+
 Activiti Core Common Libraries

activiti-dependencies/README.md

 # activiti-dependencies
+
 Activiti Dependencies BOM (Bill of Materials)

activiti-examples/README.md

@@ -8,6 +8,7 @@ This repository contains Activiti Core Examples using the new ProcessRuntime and
 - activiti-api-spring-integration-example: simple example combining Spring Integration framework and the new ProcessRuntime APis
 
 These examples are updated regularly to consume our frequent releases which can be found in our Alfresco Nexus Repository:
+
 ```
 <repositories>
     <repository>
@@ -16,7 +17,9 @@ These examples are updated regularly to consume our frequent releases which can
     </repository>
 </repositories>
 ```
+
 You can also take a look at our tags for more stable releases such as:
+
 - [Beta2](https://github.com/Activiti/activiti-examples/blob/7.0.0.Beta2/activiti-api-basic-full-example/pom.xml)
 
 Which uses the Maven Artifacts published in Maven Central.

ide-configuration/.editorconfig

@@ -14,7 +14,6 @@ indent_size = 4
 
 [*.md]
 max_line_length = off
-trim_trailing_whitespace = false
 
 [Makefile]
 indent_style = tab