diff --git a/README.adoc b/README.adoc index 9a1fdb4..a98a9f9 100644 --- a/README.adoc +++ b/README.adoc @@ -1,12 +1,32 @@ == Empty Repository -This is just an empty repository to play around with some Diagrams-as-Code tools. +This is just an empty repository to play around with some Docs-as-Code and Diagrams-as-Code tools. -To open this repository in gitpod, just preface the URL with `gitpod.io#`. +To open this repository you have different options: -Next, gitpod will start a web based visual studio instance with everything pre-installed. +* clone locally and use the IDE of your choice with plugins for AsciiDoc, PlantUML, draw.io and so on (we recommend IntelliJ IDEA or Visual Studio Code) +* in gitpod: just preface the URL with `gitpod.io#`. +* in Github Codespaces: via button "Code" -Open this `README.adoc` and press `Ctrl+k` then `v` to aktivate the AsciiDoc preview. +image::src/docs/images/codespaces.png[] + +Next, in gitpod and Github Codespaces there will be a web based visual studio instance with everything pre-installed. + +Open this `README.adoc` and press `Ctrl+k` then `v` to activate the AsciiDoc preview. + +=== Part I: AsciiDoc, PlantUML and draw.io + +For the Docs-as-Code approach open xref:src/docs/docs-as-code.adoc[] + +For the Diagrams-as-Code approach open xref:src/docs/diagrams-as-code.adoc[] and start hacking. + +Further informations: + +https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/[Ascii Doc cheat sheet] + +https://kroki.io/[Kroki Server] + +https://plantuml.com/[PlantUML] There are some german exercises which can be found at https://doctoolchain.org/empty-workshop/Uebungen.html . @@ -14,7 +34,7 @@ Now open xref:src/docs/diagrams-as-code.adoc[] and start hacking. ''' -=== advanced +=== Part II: full software architecture documentation with arc42 and doctToolchain To install _docToolchain_, switch to the terminal and run @@ -26,11 +46,20 @@ chmod +x dtcw ./dtcw install doctoolchain ---- -To preview the files, start a small server from within the terminal: +You'll find more informations at the https://doctoolchain.org/docToolchain/v2.0.x/020_tutorial/010_Install.html[docToolchain tutorial]. + +We'll use https://arc42.org/[arc42] as template for architecture documentation and can install it as a template in docToolchain. + +To preview the files (e.g. html files), start a small server from within the terminal: [code, bash] ---- python -m http.server 8000 ---- -Gitpod will now ask you what to do with the opened port. Just click on "open in browser" and navigate through the `build` folder. +Gitpod or Codespaces will now ask you what to do with the opened port. Just click on "open in browser" and navigate through the `build` folder. + +=== Practical example + +We'll use the sample task for the CPSA‑A examination task of https://www.isaqb.org/[iSAQB] https://www.isaqb.org/certifications/examinations/cpsa-advanced-level-examinations/[advanced level] as an example: +https://www.isaqb.org/download/advanced-level-sample-task-of-the-cpsa-a-examination-task/?wpdmdl=11618[BigSpender] \ No newline at end of file diff --git a/src/docs/asciidoc/images/asciidoc-cheat-sheet.webp b/src/docs/asciidoc/images/asciidoc-cheat-sheet.webp new file mode 100644 index 0000000..8bb55c4 Binary files /dev/null and b/src/docs/asciidoc/images/asciidoc-cheat-sheet.webp differ diff --git a/src/docs/asciidoc/images/asciidoctor-cheatsheet.png b/src/docs/asciidoc/images/asciidoctor-cheatsheet.png new file mode 100644 index 0000000..1d47559 Binary files /dev/null and b/src/docs/asciidoc/images/asciidoctor-cheatsheet.png differ diff --git a/src/docs/asciidoc/images/logo.jpg b/src/docs/asciidoc/images/logo.jpg new file mode 100644 index 0000000..175ad52 Binary files /dev/null and b/src/docs/asciidoc/images/logo.jpg differ diff --git a/src/docs/asciidoc/index.adoc b/src/docs/asciidoc/index.adoc new file mode 100644 index 0000000..d3dcea2 --- /dev/null +++ b/src/docs/asciidoc/index.adoc @@ -0,0 +1,13 @@ += AsciiDoc kennenlernen + +Probiert die folgenden Formatierungen aus. Verwendet die Dokumentation (https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/) die beiden Cheat Sheets, die Ordner `images` liegen. + +* AsciiDoc Formatierungen +* Listen +* Attributes +* Bilder +* Tabellen +* Anchors +* Source-Code +* Modulare Dokumentation +* Diagramme diff --git a/src/docs/docs-as-code.adoc b/src/docs/docs-as-code.adoc new file mode 100644 index 0000000..1185ec6 --- /dev/null +++ b/src/docs/docs-as-code.adoc @@ -0,0 +1,38 @@ +:imagesdir: images + +== AsciiDoc Formatierungen + +// Markdown, Headline, paragraph, bold, italic + +Headline + +The quick brown fox jumps over the lazy dog + +== Listen + +// normal, numbered, checkbox, css-class + +kuchen +butter +milch +eier + +== Attributes + +== Bilder + +//block, inline, imagesdir + +== Tabellen + +== Anchors + +//xref + +== Source-Code + +//linenums, include, tags + +== Modulare Dokumentation + +//leveloffset \ No newline at end of file diff --git a/src/docs/images/codespaces.png b/src/docs/images/codespaces.png new file mode 100644 index 0000000..27ed22d Binary files /dev/null and b/src/docs/images/codespaces.png differ