docs: typos and add traductions

add CODE_OF_CONDUCT in french
add CONTRIBUTING in french

Signed-off-by: Olivier Albertini <[email protected]>

CHANGELOG.md

@@ -11,4 +11,4 @@ Sorry for that. We try to fix lerna config when publishing Typescript packages t
 
 ## v1.0.0
 
--   Initial release
+-   Initial release

CODE_OF_CONDUCT.md

@@ -1,3 +1,4 @@
+[Français](CODE_OF_CONDUCT_FR.md)
 
 # Code of Conduct
 

CODE_OF_CONDUCT_FR.md

@@ -0,0 +1,3 @@
+# Code de conduite
+
+Les participants aux projets doivent souscrire au code de conduite que la Ville de Montréal a adopté. Veuillez lire [le texte intégral] (http://ville.montreal.qc.ca/pls/portal/docs/page/intra_fr/media/documents/code_conduite_employes.pdf) afin de comprendre quelles actions seront ou ne seront pas tolérées.

CONTRIBUTING.md

@@ -1,3 +1,5 @@
+[Français](CONTRIBUTING_FR.md)
+
 # How to Contribute
 
 This library is one of the open source projects of the Ville de Montréal which is currently under active development and which is also used to operate online services on [beta.montreal.com](https://beta.montreal.com).
@@ -17,7 +19,7 @@ We will do our best to keep `master` in good shape, with tests passing at all ti
 ### Github
 
 My PR addresses the following Github issues and references them in the PR title. For example, "#XXX My PR"
-In case you are fixing a typo in the documentation you can prepend your commit with #XXX, code changes always need a Github issue.
+In case you are fixing a typo in the documentation you can prepend your commit with docs: xxxx #XXX, code changes always need a Github issue.
 
 #### Description
 

CONTRIBUTING_FR.md

@@ -0,0 +1,45 @@
+# Comment contribuer
+
+Cette bibliothèque est l’un des projets open source de la Ville de Montréal. Elle est utilisé  dans les services en ligne sur [beta.montreal.com] (https://beta.montreal.com).
+
+## [Code de conduite] (http://ville.montreal.qc.ca/pls/portal/docs/page/intra_fr/media/documents/code_conduite_employes.pdf)
+
+Les participants aux projets doivent souscrire au code de conduite que la Ville de Montréal a adopté. Veuillez lire [le texte intégral] (http://ville.montreal.qc.ca/pls/portal/docs/page/intra_fr/media/documents/code_conduite_employes.pdf) afin de comprendre quelles actions seront ou ne seront pas tolérées.
+
+## Développement ouvert
+
+Tous les travaux sur cette bibliothèque se font directement sur [GitHub] (/). Les membres de l'équipe principale et les contributeurs externes envoient des demandes "Pull request" qui passent par le même processus de révision.
+
+### `master` est dangereux
+
+Nous ferons de notre mieux pour garder la branche `master` en bonne forme, avec des tests. Mais pour aller vite, nous allons faire des changements d’API. Ces changements pourraient ne pas être compatible avec votre application. Nous ferons de notre mieux pour communiquer ces modifications et toujours disposer de la version appropriée afin que vous puissiez verrouiller une version spécifique si besoin est.
+
+### Github
+
+Ma PR traite les demandes suivantes de Github et les référence dans le titre de ma PR. Par exemple, "#XXX My PR"
+Si vous corrigez une faute de frappe dans la documentation, vous pouvez l'ajouter à votre commit avec docs: xxxx #XXX. Les modifications de code nécessitent toujours une demande Github.
+
+#### La description
+
+Voici quelques détails sur ma PR, y compris des captures d'écran de toutes les modifications apportées à l'interface utilisateur:
+
+-   Clarifiez la documentation.
+-   Pas de changements d'interface utilisateur.
+
+#### Tests
+
+Ma PR ajoute les tests unitaires suivants OU n'a pas besoin de test pour cette très bonne raison:
+
+-   Ce n'est qu'un simple changement de documentation.
+
+#### Commits
+  Mon commit référence dans le sujet la demande Github (recommandé),
+  et j'ai **écrasé** plusieurs commits s'ils traitent la même chose.
+  De plus, mes commits suivent les instructions de ["Comment rédiger un bon message de validation git"] (https://www.conventionalcommits.org/fr/v1.0.0-beta.3)
+
+#### Documentation
+  En cas de nouvelle fonctionnalité, ma PR ajoute une documentation décrivant son utilisation.
+
+## Certificat d'origine du développeur (DCO)
+Pour accepter vos demandes, nous devons vous soumettre un DCO. Il vous suffit d'ajouter l'option de ligne de commande `-s` pour l'ajouter automatiquement à votre message de validation.
+[Plus de détails] (https://github.com/probot/dco)

README.md

@@ -277,6 +277,7 @@ IoC.bindToObject(bpmnPlatformClientConfig, CORE_IDENTIFIER.camunda_external_conf
 // For Zeebe platform
 const zeebeClientConfig = { ...configBase, baseUrl: 'localhost:2650', timeout: 2000 };
 
+// For Zeebe exporter (Elasticsearch instance)
 const zeebeElasticExporterConfig = {
     url: `http://localhost:9200`,
 };
@@ -294,27 +295,30 @@ Strategies are automatically handled.
 If an exeption is bubble up from the task, failure strategy  is raised, otherwise it's success.
 
 ```javascript
-// the idea is to create your own but imagine that your worker works mainly with REST API
+// the idea is to create your own but imagine that your worker works mainly with HTTP REST API
 class ServerErrorHandler extends ErrorHandlerBase {
   constructor(config: { maxRetries: number }) {
     super(config);
   }
 
-  public isHandled(error: IDciErrorResponse<IDciResponse<IApiError>>): boolean {
+  public isHandled(error: IErrorResponse<IResponse<IApiError>>): boolean {
     return error.response.status >= 500;
   }
-  public handle(error: IDciErrorResponse<IDciResponse<IApiError>>, message: IMessage): Failure {
+  public handle(error: IErrorResponse<IResponse<IApiError>>, message: IMessage): Failure {
     const retries = this.getRetryValue(message);
     return new Failure(error.message, this.buildErrorDetails(error, message), retries, 2000 * retries);
   }
 }
+
+// You got the idea...
+
 // You could create also
 // BadRequestErrorHandler
 // TimeoutErrorHandler
 // UnManagedErrorHandler
 // ...
 // Then you could build your strategy
-/// "FailureStrategy" implements "IFailureStrategy" provided by workit-camunda
+/// "FailureStrategy" implements "IFailureStrategy", this interface is provided by workit-camunda
 const strategy = new FailureStrategy([
   new AxiosApiErrorHandler(errorConfig, [
     new BadRequestErrorHandler(errorConfig),
@@ -354,6 +358,8 @@ npm test
 
 ### Zeebe
 
+TODO: provide helm chart.
+But in the meantime, you can do for development: 
 ```bash
 kubernetes/run
 ```

packages/workit-camunda/CHANGELOG.md

@@ -11,4 +11,4 @@ Sorry for that. We try to fix lerna config when publishing Typescript packages t
 
 ## v1.0.0
 
--   Initial release
+-   Initial release

packages/workit-camunda/README.md

@@ -24,6 +24,7 @@ This package can be useful because:
 ## Documentation
 
 -   [.docs](.docs/) contains written documentation
+-   Comprehensive API documentation is available [online](https://villedemontreal.github.io/workit/) and in the `docs` subdirectory
 
 ## Installing
 
@@ -271,6 +272,7 @@ IoC.bindToObject(bpmnPlatformClientConfig, CORE_IDENTIFIER.camunda_external_conf
 // For Zeebe platform
 const zeebeClientConfig = { ...configBase, { baseUrl: 'localhost:2650', timeout: 2000 };
 
+// Zeebe exporter (Elasticsearch instance)
 const zeebeElasticExporterConfig = {
     url: `http://localhost:9200`,
 };