Usage
Last updated
Last updated
After installing and starting the trial period, the app will add a custom field name UML text to the Jira instance.
The first step is to add the custom field UML text to issue types and projects.
Navigate to the Custom fields page.
Search for the custom field UML text and add it to screens.
On an issue view, click on the “three dots” icon and select UML Diagrams.
Click on Project settings on the left sidebar.
On the Project settings page, click on Apps on the left sidebar.
Click on App fields on the left sidebar and enable Mermaid UML for Jira Cloud.
Go back to the Project settings page, click on Issue types on the left sidebar.
Drag the UML text field from the right sidebar and drop it into the Description fields area.
Click on the Edit button.
Please do not edit the custom field itself. Whenever you want to add or modify graphs, please use the app’s Edit button.
The UML content is wrapped around by {uml}…{uml}. The diagram is defined using Mermaid. Mermaid (https://mermaid-js.github.io/mermaid/#/) allows you to define UML diagrams in plain-text format just like Markdown. For a live editor to draft your diagrams, please try https://mermaidjs.github.io/mermaid-live-editor.
Sample content:
After that, click Save.
Flowcharts can be rendered with Mermaid. See more https://mermaid-js.github.io/mermaid/#/flowchart.
Sequence diagrams can be rendered with Mermaid. See more https://mermaid-js.github.io/mermaid/#/sequenceDiagram.
Class diagrams can be rendered with Mermaid. See more https://mermaid-js.github.io/mermaid/#/classDiagram.
State diagrams can be rendered with Mermaid. See more https://mermaid-js.github.io/mermaid/#/stateDiagram.
User Journey can be rendered with Mermaid. See more https://mermaid-js.github.io/mermaid/#/user-journey.
Gantt charts can be rendered with Mermaid. See more https://mermaid-js.github.io/mermaid/#/gantt.
Pie charts can be rendered with Mermaid. See more https://mermaid-js.github.io/mermaid/#/pie.
