From 6aad5f9f2b2f407c7ee0698dbb633726483fc1a6 Mon Sep 17 00:00:00 2001 From: Marcin Michniewicz <45601541+aibcmars@users.noreply.github.com> Date: Wed, 16 Sep 2020 17:47:16 +0200 Subject: [PATCH 1/3] [DOC] improve guidelines for contributors (#630) fixed link, supported node version, removed TS version --- CONTRIBUTING.md | 5 ++--- docs/development/README.md | 2 +- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 763b927899..56046aa7b6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,7 +12,7 @@ There are many ways to contribute: - submitting bug reports and feature requests in the [Github Issues](https://github.com/process-analytics/bpmn-visualization-js/issues/new) - [writing code](CONTRIBUTING.md#code-and-documentation-changes) which can be incorporated into `bpmn-visualization` itself - [improving](CONTRIBUTING.md#code-and-documentation-changes) the documentation -- improve the existing example applications to demonstrate features in `bpmn-visualization` +- improve the existing [example applications](https://github.com/process-analytics/bpmn-visualization-examples) to demonstrate features in `bpmn-visualization` ## Code and documentation changes guidelines @@ -58,8 +58,7 @@ git checkout -b 25-annotations_to_tasks #### Requirements -- `Node.js` >= 12.x (may work with older versions but without any guarantee) -- `Typescript` 3.x +- `Node.js` 12.16.x and 14.11.x (may work with other versions but without any guarantee) - `Supported OS` (see the Github Build workflow for more details): Windows/Linux/MacOs #### Build diff --git a/docs/development/README.md b/docs/development/README.md index 42c8690017..7b90b0f923 100644 --- a/docs/development/README.md +++ b/docs/development/README.md @@ -4,6 +4,6 @@ General information are available in the [Contributing Guide](../../CONTRIBUTING Information about the library internals are available in the [architecture folder](./docs/architecture) or in html form in the [documentation site](https://process-analytics.github.io/bpmn-visualization-js/#_architecture_and_development) Here are some tips to help during development: -- [how to support new BPMN elements](./bpmn-support-how-to.adoc) +- [how to support new BPMN elements](./bpmn-support-how-to.md) - [mxgraph version bump](./mxgraph-version-bump.md) - [testing](./testing.md) From af8830e3ef8a14dbbba894c47e7e5f7e4fb82258 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Souchet=20C=C3=A9line?= <4921914+csouchet@users.noreply.github.com> Date: Thu, 17 Sep 2020 09:26:13 +0200 Subject: [PATCH 2/3] [DOC] Remove Jest plugin tips for VSCode (#628) Remove Jest plugin tips for VSCode, because it doesn't support multi configuration --- docs/development/ide-configuration.md | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/docs/development/ide-configuration.md b/docs/development/ide-configuration.md index 03dd04856e..293e1b5d9f 100644 --- a/docs/development/ide-configuration.md +++ b/docs/development/ide-configuration.md @@ -69,17 +69,11 @@ An [AsciiDoc IntelliJ Plugin](https://plugins.jetbrains.com/plugin/7391-asciidoc Install the EditorConfig extension. A configuration file already exists in the repository so it will apply right after the extension installation. -#### [Jest tests](https://github.com/jest-community/vscode-jest#how-to-get-it) - -To be able to run tests from VS Code, you firstly install the Jest extension, then, go to the **Run** menu of VS Code. -You can run 2 test configurations: +#### [Debugging TypeScript code](https://code.visualstudio.com/docs/typescript/typescript-debugging) +The `launch.json` file is already configured to execute tests: - unit tests: `test:unit` - end to end tests: `test:e2e` - -If you want to use coverage, follow this tutorial: https://github.com/jest-community/vscode-jest#how-do-i-show-code-coverage - -#### [Debugging TypeScript code](https://code.visualstudio.com/docs/typescript/typescript-debugging) -The `launch.json` file is already configured to execute unit & e2e tests. + You can duplicate these configurations or create another, if you want/need. #### [Draw.io Diagram](https://marketplace.visualstudio.com/items?itemName=hediet.vscode-drawio) From 792d3f378562cbe212b10e8578632de82744a32a Mon Sep 17 00:00:00 2001 From: Thomas Bouffard <27200110+tbouffard@users.noreply.github.com> Date: Thu, 17 Sep 2020 10:30:06 +0200 Subject: [PATCH 3/3] [DOC] highlight demo and examples live environments (#634) Highlight environments in both README and html docs. In addition - update reference to current development milestones in html docs - add license badge and update the `powered by statically.io` in the README --- README.md | 14 ++++++++------ docs/bpmn-support.adoc | 2 +- docs/intro.adoc | 18 +++++++++++------- 3 files changed, 20 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 973c697979..95b6109842 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](CONTRIBUTING.md) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md) +[![License](https://img.shields.io/github/license/process-analytics/bpmn-visualization-js?color=blue)](LICENSE) `bpmn-visualization` is a TypeScript library to visualize process execution data on [BPMN](https://www.omg.org/spec/BPMN/2.0.2/) diagrams with @@ -20,8 +21,8 @@ diagrams with ## Demo -The [demo environment](https://cdn.statically.io/gh/process-analytics/bpmn-visualization-examples/master/demo/index.html) -let you load a BPMN file to see how the lib renders it. Various versions of the lib are available. +Give a try to the [__:fast_forward: demo live environment__](https://cdn.statically.io/gh/process-analytics/bpmn-visualization-examples/master/demo/index.html). +The demo let you load a BPMN file to see how `bpmn-visualization` renders it. Various versions of the lib are available. If you need BPMN examples, you can use resources from - the [BPMN Model Interchange Working Group (BPMN MIWG)](http://www.omgwiki.org/bpmn-miwg) @@ -32,10 +33,11 @@ If you need BPMN examples, you can use resources from ## Examples -If you need examples about `bpmn-visualization` usage and extensibility, go to the [bpmn-visualization-examples](https://github.com/process-analytics/bpmn-visualization-examples/) -repository. +Want to know more about `bpmn-visualization` usage and extensibility? Have a look at the +[__:fast_forward: live examples site__](https://cdn.statically.io/gh/process-analytics/bpmn-visualization-examples/master/examples/index.html). -These examples are also available in the [examples live environment](https://cdn.statically.io/gh/process-analytics/bpmn-visualization-examples/master/examples/index.html). +For more technical details and how-to, go to the [bpmn-visualization-examples](https://github.com/process-analytics/bpmn-visualization-examples/) +repository. # Roadmap @@ -70,4 +72,4 @@ for more details: [![statically.io logo](https://statically.io/icons/icon-96x96.png "statically.io")](https://statically.io) -**[statically.io](https://statically.io)** (demo environment) +**[statically.io](https://statically.io)** (demo and examples live environments) diff --git a/docs/bpmn-support.adoc b/docs/bpmn-support.adoc index a131e27c3a..8912a76944 100644 --- a/docs/bpmn-support.adoc +++ b/docs/bpmn-support.adoc @@ -3,7 +3,7 @@ == Supported BPMN Elements :icons: font -NOTE: The short term support roadmap is available in https://github.com/process-analytics/bpmn-visualization-js/milestones[Github milestones] +NOTE: The BPMN support roadmap is available in https://github.com/process-analytics/bpmn-visualization-js/milestones[Github milestones] The following presents BPMN elements that can be displayed by the lib and states which is their rendering status i.e. if diff --git a/docs/intro.adoc b/docs/intro.adoc index 7de4d391a8..270b816f63 100644 --- a/docs/intro.adoc +++ b/docs/intro.adoc @@ -3,8 +3,11 @@ `bpmn-visualization` is a TypeScript library to visualize process execution data on https://www.omg.org/spec/BPMN/2.0.2/[BPMN] diagrams. It is in early development stages and is subject to changes prior to the `1.0.0` release. -We are currently focusing on the <> to be able to render most of the BPMN -elements. Then, we will work on BPMN extensions, library extension points, display options for execution data with interactive +For now, we render the most <>. Notice that there is currently no plan to support `Conversation` and `Choreography`. + +We are currently focusing on the https://github.com/process-analytics/bpmn-visualization-js/milestone/18[packaging] of the library. + +Then, we will work on BPMN extensions, library extension points, display options for execution data with interactive capacities. **Supported Browsers**: Chrome, Firefox, Safari, Edge. @@ -13,8 +16,8 @@ capacities. == Demo and examples === Demo -The https://cdn.statically.io/gh/process-analytics/bpmn-visualization-examples/master/demo/index.html[demo environment] -let you load a BPMN file to see how the lib renders it. Various versions of the lib are available. +Give a try to the https://cdn.statically.io/gh/process-analytics/bpmn-visualization-examples/master/demo/index.html[**icon:forward[] demo live environment**]. +The demo let you load a BPMN file to see how `bpmn-visualization` renders it. Various versions of the lib are available. If you need BPMN examples, you can use resources from @@ -25,7 +28,8 @@ If you need BPMN examples, you can use resources from === Examples -If you need examples about `bpmn-visualization` usage and extensibility, go to the https://github.com/process-analytics/bpmn-visualization-examples/[bpmn-visualization-examples] -repository. +Want to know more about `bpmn-visualization` usage and extensibility? Have a look at the +https://cdn.statically.io/gh/process-analytics/bpmn-visualization-examples/master/examples/index.html[**icon:forward[] examples live environment**]. -These examples are also available in the https://cdn.statically.io/gh/process-analytics/bpmn-visualization-examples/master/examples/index.html[examples live environment]. +For more technical details and how-to, go to the https://github.com/process-analytics/bpmn-visualization-examples/[bpmn-visualization-examples] +repository.