Commit d9036acd authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Merge branch 'docs/fix-plantuml-topic' into 'master'

Remove <pre> tag and other fixes

See merge request gitlab-org/gitlab-ce!30652
parents a296ae99 4f87075b
# PlantUML & GitLab # PlantUML & GitLab
> [Introduced][ce-8537] in GitLab 8.16. > [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8537) in
> GitLab 8.16.
When [PlantUML](http://plantuml.com) integration is enabled and configured in When [PlantUML](http://plantuml.com) integration is enabled and configured in
GitLab we are able to create simple diagrams in AsciiDoc and Markdown documents GitLab we are able to create simple diagrams in AsciiDoc and Markdown documents
...@@ -15,7 +16,9 @@ server that will generate the diagrams. ...@@ -15,7 +16,9 @@ server that will generate the diagrams.
With Docker, you can just run a container like this: With Docker, you can just run a container like this:
`docker run -d --name plantuml -p 8080:8080 plantuml/plantuml-server:tomcat` ```sh
docker run -d --name plantuml -p 8080:8080 plantuml/plantuml-server:tomcat
```
The **PlantUML URL** will be the hostname of the server running the container. The **PlantUML URL** will be the hostname of the server running the container.
...@@ -26,7 +29,7 @@ own PlantUML server is easy in Debian/Ubuntu distributions using Tomcat. ...@@ -26,7 +29,7 @@ own PlantUML server is easy in Debian/Ubuntu distributions using Tomcat.
First you need to create a `plantuml.war` file from the source code: First you need to create a `plantuml.war` file from the source code:
``` ```sh
sudo apt-get install graphviz openjdk-8-jdk git-core maven sudo apt-get install graphviz openjdk-8-jdk git-core maven
git clone https://github.com/plantuml/plantuml-server.git git clone https://github.com/plantuml/plantuml-server.git
cd plantuml-server cd plantuml-server
...@@ -36,7 +39,7 @@ mvn package ...@@ -36,7 +39,7 @@ mvn package
The above sequence of commands will generate a WAR file that can be deployed The above sequence of commands will generate a WAR file that can be deployed
using Tomcat: using Tomcat:
``` ```sh
sudo apt-get install tomcat7 sudo apt-get install tomcat7
sudo cp target/plantuml.war /var/lib/tomcat7/webapps/plantuml.war sudo cp target/plantuml.war /var/lib/tomcat7/webapps/plantuml.war
sudo chown tomcat7:tomcat7 /var/lib/tomcat7/webapps/plantuml.war sudo chown tomcat7:tomcat7 /var/lib/tomcat7/webapps/plantuml.war
...@@ -46,7 +49,7 @@ sudo service tomcat7 restart ...@@ -46,7 +49,7 @@ sudo service tomcat7 restart
Once the Tomcat service restarts the PlantUML service will be ready and Once the Tomcat service restarts the PlantUML service will be ready and
listening for requests on port 8080: listening for requests on port 8080:
``` ```text
http://localhost:8080/plantuml http://localhost:8080/plantuml
``` ```
...@@ -57,9 +60,10 @@ you can change these defaults by editing the `/etc/tomcat7/server.xml` file. ...@@ -57,9 +60,10 @@ you can change these defaults by editing the `/etc/tomcat7/server.xml` file.
You need to enable PlantUML integration from Settings under Admin Area. To do You need to enable PlantUML integration from Settings under Admin Area. To do
that, login with an Admin account and do following: that, login with an Admin account and do following:
- in GitLab go to **Admin Area**->**Settings**->**Integrations**->**PlantUML** - In GitLab, go to **Admin Area > Settings > Integrations**.
- check **Enable PlantUML** checkbox - Expand the **PlantUML** section.
- set the PlantUML instance as **PlantUML URL** - Check **Enable PlantUML** checkbox.
- Set the PlantUML instance as **PlantUML URL**.
## Creating Diagrams ## Creating Diagrams
...@@ -68,7 +72,6 @@ our AsciiDoc snippets, wikis and repos using delimited blocks: ...@@ -68,7 +72,6 @@ our AsciiDoc snippets, wikis and repos using delimited blocks:
- **Markdown** - **Markdown**
<pre>
````markdown ````markdown
```plantuml ```plantuml
Bob -> Alice : hello Bob -> Alice : hello
...@@ -78,23 +81,23 @@ our AsciiDoc snippets, wikis and repos using delimited blocks: ...@@ -78,23 +81,23 @@ our AsciiDoc snippets, wikis and repos using delimited blocks:
- **AsciiDoc** - **AsciiDoc**
``` ```text
[plantuml, format="png", id="myDiagram", width="200px"] [plantuml, format="png", id="myDiagram", width="200px"]
---- ----
Bob->Alice : hello Bob->Alice : hello
Alice -> Bob : Go Away Alice -> Bob : Go Away
---- ----
``` ```
- **reStructuredText** - **reStructuredText**
``` ```text
.. plantuml:: .. plantuml::
:caption: Caption with **bold** and *italic* :caption: Caption with **bold** and *italic*
Bob -> Alice: hello Bob -> Alice: hello
Alice -> Bob: Go Away Alice -> Bob: Go Away
``` ```
You can also use the `uml::` directive for compatibility with [sphinxcontrib-plantuml](https://pypi.org/project/sphinxcontrib-plantuml/), but please note that we currently only support the `caption` option. You can also use the `uml::` directive for compatibility with [sphinxcontrib-plantuml](https://pypi.org/project/sphinxcontrib-plantuml/), but please note that we currently only support the `caption` option.
...@@ -120,5 +123,3 @@ Some parameters can be added to the AsciiDoc block definition: ...@@ -120,5 +123,3 @@ Some parameters can be added to the AsciiDoc block definition:
- *height*: Height attribute added to the img tag. - *height*: Height attribute added to the img tag.
Markdown does not support any parameters and will always use PNG format. Markdown does not support any parameters and will always use PNG format.
[ce-8537]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8537
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment