Skip to content

Add support for PlantUML diagrams in Asciidoc.

Horacio Sanson requested to merge hsanson/gitlab-ce:asciidoctor-plantuml into master

What does this MR do?

Add support for PlantUML diagrams in Asciidoc documents.

Are there points in the code the reviewer needs to double check?

Why was this MR needed?

A diagram tool available for issues, wikis, comments and any document in a repo is a powerful tool that can make gitlab appealing to a lot of corporations and institutions.

##Diagram Example

Example diagram inside Asciidoc

[plantuml, format="png", width="100px",alt="my diagram"]
--
Alice -> Bob : ping
Bob -> Alice : pong
--

Format can be "png", "svg" or "txt". Note that not all browsers (e.g. IE) support svg as source in img elements.

For more examples of PlantUML diagrams and the syntax refer to PlantUML Docs

Does this MR meet the acceptance criteria?

  • Changelog entry added : I have tried to find this bin/changelog in the GDK but is not there....

  • Documentation created/updated : There is no documentation additions. In fact asciidoc overall documentation is lacking in Gitlab and I plan to fix that in future MRs.

  • API support added : There is no new APIs added by this merge request.

  • Tests

    • Added for this feature/bug : Not sure how to test features that require third party service. Need pointers here.

    • All builds are passing : There are several builds that do not pass but are completely unrelated with the changes in this MR.

  • Conform by the merge request performance guides : There is no database access on this MR. Only code to generate PlantUML encoded URLs that are then retrieved by the clients.

  • [x ] Conform by the style guides

  • Branch has no merge conflicts with master (if it does - rebase it please) : Gitlab changes very fast!.. to minutes speed. How can I rebase and push changes to a merge request? this breaks havoc.

  • Squashed related commits together

What are the relevant issue numbers?

#17603 (closed)

Merge request reports