Giter Site home page Giter Site logo

docs.bpmn.io's Introduction

The website is not published yet. It is still in WIP stage.

docs.bpmn.io 📓

Welcome to docs.bpmn.io. This repository contains documentation for:

  • diagram-js
  • bpmn-js
  • dmn-js

libraries.

Running Locally

This repository is based on Jekyll and hosted via GitHub Pages. To run locally:

Install bundler if not installed before:

gem install bundler jekyll

Run the website:

bundle exec jekyll serve --incremental

This should take couple of minutes until the page is built and served in http://localhost:4000/ Note that the incremental flag helps to build only the modified pages, which makes thing much faster in case we're modifying the content.

Note about search

Pages added & removed from the docs should automatically be handled, so no need to do extra steps in order to take care of search functionality.

Playing With Colors 🎨

These color variables may be modified to achieve custom themes inside bpmn-io.scss:

    $body-background-color
    $sidebar-color
    $border-color

    $body-text-color
    $body-heading-color
    $nav-child-link-color
    $search-result-preview-color

    $link-color
    $btn-primary-color
    $base-button-color

    $code-background-color
    $search-background-color
    $table-background-color
    $feedback-color

Tip About Plugging Back DMN Content In

In order to plug back the DMN related content in into the website, undo this commit.

docs.bpmn.io's People

Contributors

barmac avatar jbampton avatar maxtru avatar nikku avatar oguzeroglu avatar ricardomatias avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar

Forkers

guimconde sombit-g jbampton greggubarev sriram275 pedr0cruz geeestar cuizijian geogerytony yuntao1997 irrdc sumatris

docs.bpmn.io's Issues

Include CommandInterceptor

Is your feature request related to a problem? Please describe

We should include CommandInterceptor class in the documentation. It's not a module, so we should find a place under Commands section to include this one.

Describe the solution you'd like

Add another page under Commands to mention about intercepting commands.

Describe alternatives you've considered

None.

Consider alternatives for top-level structure

What should we do?

We should discuss if it makes sense to split the documentation per toolkit (bpmn-js/dmn-js etc.) rather than components (modules, events etc.)

Why should we do it?

Better experience for users and developers.

Create content for BPMN Modules

Child of #12

We should create content for following pages:

Create content for common commands

Child of #22

We should create content for following pages:

parsing features

Todo:

  • Respect markdown language identifiers in code examples (i.e. javascript)
  • Respect nested @param annotations. i.e.: {String} menu.headerEntries[].className
  • Respect optional @param annotations. i.e.: {Number} [priority]

Create content for diagram-js modules

Child of #12

We should create content for following pages:

Create content for Modules page

We should create content for the Modules page.

Sub tasks:

  • Create content for diagram-js modules #10
  • Create content for bpmn-js modules #9
  • Crate content for Adding/Removing/Customizing modules #11

Create content for common events

Child of #19

We should create content for following pages:

Adjust top-level structure, migrate to target platform and publish live system

This is an epic issue which may be broken down into multiple tasks, if needed

What should we do?

We plan to have a docs page ready very soon.

So far we planned to go with this concept. However, we decided to do some small revisions with the goal of having a solid structure, which does not require any non-content related changes any time soon.

Concrete:

  • Migrate docs.bpmn.io to suitable solution, which allows us to use GitHub as content source, be in line with Camunda technology stack, allow for a project-driven top-level structure (e.g., bpmn-js, dmn-js, ...) and have the various features requested here. (E.g., docusarus)
  • Once we have the infrastructure ready, publish it into live production environment (rationale: this will drive the motivation to extend and use the docs)
  • Add minor note to https://github.com/bpmn-io/rfcs/tree/master/003-bpmn-io-documentation stating that we decided differently / changed the approach

Note that the list of the above tasks might be extended or changed since this is an epic issue

Why should we do it?

Various user requests + team strategy.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.