Skip to content

Commit

Permalink
docs: add plantuml parsing to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tsypuk committed Nov 18, 2023
1 parent 4c5800c commit c39a6c6
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions docs/docs/core-components/integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@ end
- ``Diagrams as a Code`` approach is initially implemented from early versions. You can track syntax of resources declaration
for [Core](../core-components), [AWS](../aws-components) and [On-Prem](../onprem-components) resources.
- ingestion resources declared in [external ``YAML`` file](../core-components/yaml.html)
- augment from UML sequence diagrams [mermaid UML format](../core-components/uml_mermaid.md)
- augment from UML sequence diagrams (plantuml UML format) UNDER DEVELOPMENT
- augment from UML sequence diagrams [mermaid UML format](../core-components/uml.md)
- augment from UML sequence diagrams [plantuml UML format](../core-components/uml.md)

Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
layout: default
title: UML from mermaid
title: UML mermaid/plantuml
parent: CORE Components
nav_order: 5
date: 2023-10-21
---

## UML ingestion from mermaid format
## UML ingestion from mermaid/plantuml formats

{: .d-inline-block .no_toc }

Expand All @@ -28,7 +28,7 @@ Record are rows of text.
---

Latest ``Multicloud-diagrams`` feature allows automatically parse sequence UML diagrams, detect actors, actions and represent them on source Diagram as additional connected nodes with aliases.
This makes documenting infrastructure even more robust.
This makes documenting infrastructure even more robust. Framework automatically detects diagram type passed into invocation parameter whether it is ``plantuml`` or ``mermaid``.

## Source infrastructure Diagram:

Expand All @@ -54,8 +54,8 @@ Following UML diagram in ``mermaid`` format describes ``File upload`` stage:
{% root_include ../samples/samples/file_upload.mermaid%}
```

Next UML diagram in ``mermaid`` format describes ``Processing`` stage:
- [file_upload.mermaid](../samples/samples/process.mermaid)
Next UML diagram in ``plantUML`` format that describes next ``Processing`` stage:
- [file_upload.mermaid](../samples/samples/process.plantUML)

### Mermaid UML rendered diagram:

Expand All @@ -66,7 +66,7 @@ Next UML diagram in ``mermaid`` format describes ``Processing`` stage:
### Advanced for Geeks(Mermaid UML sources):

```
{% root_include ../samples/samples/process.mermaid%}
{% root_include ../samples/samples/process.plantuml%}
```

## Ingesting UML metadata into multicloud-diagrams:
Expand All @@ -76,7 +76,7 @@ Next UML diagram in ``mermaid`` format describes ``Processing`` stage:
As usual, we create a new diagram using ``Diagrams-As-a-Code`` or open exising one:

```python
{% root_include ../samples/samples/aws_mermaid_uml.py 1:11%}
{% root_include ../samples/samples/aws_plant_uml.py 1:11%}
```

### Define mappings
Expand Down

0 comments on commit c39a6c6

Please sign in to comment.