Skip to content
Snippets Groups Projects
Commit e7cd2674 authored by George Adrian Stoica's avatar George Adrian Stoica
Browse files

update slides about documentation

parent ee9c40ed
Branches
Tags
No related merge requests found
Pipeline #85363 passed
......@@ -3,12 +3,12 @@
:icons: font
:includedir: revealjs/includes/
:LECTURE_TOPIC: Documentation
:LECTURE_NO: 7th lecture
:LECTURE_NO: 9th lecture
include::{includedir}header.adoc[]
[.smaller-80][.center-paragraph]
IT1901 Fall 2019 - {LECTURE_NO}
IT1901 Fall 2020 - {LECTURE_NO}
[background-color = "#124990"]
......@@ -18,6 +18,7 @@ IT1901 Fall 2019 - {LECTURE_NO}
- Documentation
- Markdown
- Gitlab Flavoured Markdown (GFM)
- PlantUML
[background-color = "#124990"]
......@@ -146,4 +147,28 @@ https://gitlab.stud.idi.ntnu.no/help/user/markdown
- it can be versioned same way as the code
- holding documentation in the repository and updating it will allow consulting the repository contents with the correct documentation for that snapshot in time
== Plant UML
- open source tool for UML diagrams
- it takes a textual description and produces a diagram
- supported within markdown in GitLab
- uses Graphviz to lay out the diagrams
== Adding diagrams to markdown
[source, role="stretch"]
----
```plantuml
class LatLong {
double latitude
double longitude
}
class LatLongs
LatLongs *--> "*" LatLong: "latLongs"
class MetaData
LatLong *--> "1" MetaData: "metaData"
```
----
include::{includedir}footer.adoc[]
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment