ST3

README.md

@@ -1,11 +1,7 @@
-# Swingletree [![Maintainability](https://api.codeclimate.com/v1/badges/e792e95e2c8e96e98b24/maintainability)][code-climate] [![Docker Automated build](https://img.shields.io/docker/automated/werkbank/swingletree.svg)][dockerhub-repo]
-
-<img src="static/icon.svg" width="55" align="right">
+# Swingletree
 
 Swingletree gives you the possibility to integrate a variety of software quality tools into GitHub to secure the quality of your software.
 
 Take a look at our [GitHub Page][swingletree] for more information (and the Swingletree documentation).
 
-[code-climate]: https://codeclimate.com/github/error418/swingletree/maintainability
-[dockerhub-repo]: https://hub.docker.com/r/werkbank/swingletree/tags/
-[swingletree]: https://error418.github.io/swingletree/
+[swingletree]: https://swingletree-oss.github.io/swingletree/

compose.env

@@ -0,0 +1,8 @@
+SCOTTY_STORAGE_HOST=redis
+SCOTTY_GITHUB_APP_ID: ${GH_APPID}
+SCOTTY_ELASTIC_ENABLED=true
+SCOTTY_ELASTIC_NODE=http://elastic:9200
+
+DECK_ELASTIC_ENABLED=true
+DECK_ELASTIC_NODE=http://elastic:9200
+DECK_ELASTIC_FEATURES_DASHBOARD=true

docker-compose.yml

@@ -0,0 +1,95 @@
+version: "3.3"
+
+services:
+  deck:
+    container_name: deck
+    env_file:
+      - ./compose.env
+    environment:
+      DECK_PORT: 3000
+    build:
+      context: ../deck/
+    ports:
+      - "3000:3000"
+  scotty:
+    container_name: scotty
+    env_file: 
+      - ./compose.env
+    environment:
+      SCOTTY_PORT: 3000
+      SCOTTY_STORAGE_HOST: redis
+      SCOTTY_GITHUB_APP_ID: ${GH_APPID}
+    build:
+      context: ../scotty/
+    volumes:
+      - ../scotty/gh-app.pem:/opt/scotty/gh-app.pem
+    expose:
+      - "3000"
+  gate:
+    container_name: gate
+    env_file: 
+      - ./compose.env
+    environment:
+      GATE_PORT: 3001
+    build:
+      context: ../gate/
+    ports:
+      - "3001:3001"
+
+  redis:
+    container_name: redis
+    image: redis
+    logging:
+      driver: none
+    expose:
+      - "6379"
+
+  elastic:
+    container_name: elastic
+    image: docker.elastic.co/elasticsearch/elasticsearch:7.3.1
+    logging:
+      driver: none
+    environment:
+      discovery.type: single-node
+    ports:
+      - "9200:9200"
+    expose:
+      - "9200"
+      - "9300"
+
+
+  plugin-nebula:
+    container_name: plugin-nebula
+    environment:
+      NEBULA_PORT: 3010
+    build:
+      context: ../plugin-nebula/
+    expose:
+      - "3010"
+
+  plugin-sonarqube:
+    container_name: plugin-sonarqube
+    environment:
+      SONAR_PORT: 3020
+    build:
+      context: ../plugin-sonarqube/
+    expose:
+      - "3020"
+
+  plugin-twistlock:
+    container_name: plugin-twistlock
+    environment:
+      TWISTLOCK_PORT: 3030
+    build:
+      context: ../plugin-twistlock/
+    expose:
+      - "3030"
+
+  plugin-zap:
+    container_name: plugin-zap
+    environment:
+      ZAP_PORT: 3040
+    build:
+      context: ../plugin-zap/
+    expose:
+      - "3040"

docs/_config.yml

@@ -10,9 +10,9 @@ lang: de-DE
 logo: assets/images/icon.svg
 
 baseurl: "/swingletree" # the subpath of your site, e.g. /blog/
-url: "https://error418.github.io" # the base hostname & protocol for your site
-git_address: https://github.com/error418/swingletree
-git_edit_address: https://github.com/error418/swingletree/blob/master/docs
+url: "https://swingletree-oss.github.io" # the base hostname & protocol for your site
+git_address: https://github.com/swingletree-oss/swingletree
+git_edit_address: https://github.com/swingletree-oss/swingletree/blob/master/docs
 
 blog:
   enable: false

docs/_data/docs.yml

@@ -1,19 +1,28 @@
-- title: Getting Started
+- title: General
   docs:
   - home
-  - installation
-  - configure
+  - yoke-cli
+
+- title: Installation
+  docs:
+  - install/prerequisites
+  - install/prepare
+  - install/k8s
 
 - title: Components
   docs:
   - components/elastic
-  - components/nebula
-  - components/sonarqube
-  - components/twistlock
-  - components/zap
-  - problems
+  - components/deck
+  - components/gate
+  - components/scotty
+
+- title: Plugins
+  docs:
+  - plugins/nebula
+  - plugins/sonarqube
+  - plugins/twistlock
+  - plugins/zap
 
 - title: Extend Swingletree
   docs:
-  - architecture
-  - eventbus
+  - architecture

docs/_docs/components/deck.md

@@ -0,0 +1,13 @@
+---
+title: Deck
+permalink: /docs/components/deck/
+redirect_from: /docs/index.html
+---
+
+Deck provides the web-interface of Swingletree.
+
+## Build Overview
+
+Swingletree UI offers you the `Builds` menu option, which enables you to search and view the details of the latest analysis reports.
+
+<img class="showcase" style="max-width:95%" src="../../../assets/images/analysis-report-detail.png" />

docs/_docs/components/elasticsearch.md

@@ -10,12 +10,5 @@ Swingletree can write its Analysis reports to ElasticSearch. This has following
 * Analysis Reports can be aggregated to reports using established tools like [Kibana][kibana] or [Grafana][grafana]
 * Swingletree UI offers the `Builds` menu option
 
-## Build Overview
-
-Swingletree UI offers you the `Builds` menu option, which enables you to search and view the details of the latest analysis reports.
-
-<img class="showcase" style="max-width:95%" src="../../../assets/images/analysis-report-detail.png" />
-
-
 [kibana]: https://www.elastic.co/de/products/kibana
 [grafana]: https://grafana.com/

docs/_docs/components/gate.md

@@ -0,0 +1,13 @@
+---
+title: Gate
+permalink: /docs/components/gate/
+redirect_from: /docs/index.html
+---
+
+Gate provides API endpoints of Swingletree.
+
+## Features
+
+* Provides metadata information to Swingletree plugins
+* Registers and manages plugin endpoints
+* Authenticates API calls (if auth token is configured)