Skip to content

Latest commit

 

History

History
49 lines (28 loc) · 2.56 KB

README.md

File metadata and controls

49 lines (28 loc) · 2.56 KB
Raw

OTP-PlantUML

OTP-PlantUML is a attempt to use PlantUML and create some diagrams that fit the ideas found here OTP Design Principles User's Guide. The intention is to get easy building documentation around Erlang and Elixir using OTP principles.

Diagrams

  • OTP Supervisor tree, a supervisor tree which supervisors and workers can drawing using PlantUML. Additional stereotype were provided if you need to describe a bit more in detail each process. Right now the following stereotype exists: gen_server, gen_event, gen_statem, Agent, Task, Registry, Supervisor, TaskSupervisor:

OTP Supervisor

  • OTP Sequence, sequence diagram with additional participants using stereotype and allowing sending messages, calling cast and call:

OTP Sequence

How to use

There are two plantuml include files (iuml):

  • OTP_SupervisorTree.iuml
  • OTP_Sequence.iuml

Each include file has macros which defines the diagram_type.

You need to include one of these two files using one of the following methods:

  • To be independent of any internet connectivity, download the file respective .iuml found in the root and reference it locally with
!include path/to/OTP_<diagram_type>.iuml
  • If you want to use the always up-to-date version in this repo, use the following:
!include https://raw.githubusercontent.com/joaohf/OTP-PlantUML/master/OTP_<diagram_type>.iuml

See samples about how to use these diagrams.

Contribute

This repository accepts features and improvements.

License

This project is licensed under the MIT License - see the LICENSE file for details.

References