Merge branch 'master' into 41-restructure-project-directory-structure

.gitlab-ci.yml

@@ -3,8 +3,7 @@ variables:
 
 stages:
   - test
-  - compliance
-  - build
+  - documentation
 
 before_script:
   - git config --global url."https://$GO_MODULES_USER:$GO_MODULES_ACCESS_TOKEN@code.fbi.h-da.de".insteadOf "https://code.fbi.h-da.de"

build/ci/.documentation-ci.yml

-Documentation:
+documentation:pdf:
   before_script:
     - pwd
   image:
     name: pandoc/latex
     entrypoint:
     - ''
-  stage: build
+  stage: documentation
   rules:
     - changes:
       - documentation/design/*.md
@@ -16,3 +16,31 @@ Documentation:
   artifacts:
     paths:
     - documentation/design/documentation.pdf
+
+.mdbook_common: &rust
+  before_script:
+      - cargo install mdbook
+  image:
+    name: rustdocker/rust:stable
+  stage: documentation
+  script:
+  - pwd
+  - ls
+  - mdbook build documentation --dest-dir public
+  cache:
+    paths:
+    - /root/.cargo/
+
+documentation:static:
+  rules:
+    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+  artifacts:
+    paths:
+      - public
+    expire_in: 1 week
+  <<: *rust
+
+documentation:test:
+  rules:
+    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
+  <<: *rust

build/ci/.golangci-config/.runlint.sh

 golangci-lint run\
   --config .ci/.golangci-master.yml\
   --out-format code-climate |\
-  jq -r '.[] | "\(.location.path):\(.location.lines.begin) \(.description)"'
+  jq -r '.[] | "\(.location.path):\(.location.lines.begin) \(.description)"'
\ No newline at end of file

build/ci/.security-and-compliance-ci.yml

@@ -3,13 +3,6 @@ sast:
     SAST_ANALYZER_IMAGE_TAG: '2'
     SAST_EXCLUDED_PATHS: spec, test, tests, tmp
     SEARCH_MAX_DEPTH: '4'
-  stage: compliance
-
-license_scanning:
-  stage: compliance
-
-gemnasium-dependency_scanning:
-  stage: compliance
 
 include:
   - template: Security/SAST.gitlab-ci.yml

documentation/SUMMARY.md

+# goSDN Documentation
+
+- [Introduction](design/01-introduction.md)
+- [Related Work](design/02-related-work.md)
+- [Theoretical Background](design/03-theoretical-background.md)
+- [Conceptual Design](design/04-conceptual-design.md)
+- [Implementation](design/05-implementation.md)
\ No newline at end of file

documentation/book.toml

+[book]
+authors = []
+language = "en"
+multilingual = false
+src = "."