Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] highlight demo and examples live environments #634

Merged
merged 2 commits into from
Sep 17, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)
Expand All @@ -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
Expand Down Expand Up @@ -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)** (<kbd>demo</kbd> and <kbd>examples</kbd> live environments)
2 changes: 1 addition & 1 deletion docs/bpmn-support.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
18 changes: 11 additions & 7 deletions docs/intro.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<supported-bpmn-elements,BPMN support>> 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 <<supported-bpmn-elements,common BPMN elements>>. 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.
Expand All @@ -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

Expand All @@ -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.