reorganize documentation

site/

docs/**/README.md

  - build

  - production

include:

  # Go2Scale DevSecOps

  - remote: https://gitlab.com/go2scale/jobs/raw/2020-05-31_1/jobs/documentation.gitlab-ci.yml

documentation:

  image:

    name: squidfunk/mkdocs-material:5.2.2

    entrypoint: [""]

  stage: build

  script:

    - make docs

    - mkdocs build -d ./public

  artifacts:

    when: always

    expose_as: "Documentation"

    paths:

    - public/

  except:

    variables:

      - $DOCUMENTATION_DISABLE

pages:

  stage: production

  script:

    - echo 'Deploying on Gitlab pages'

  needs:

    - job: documentation

      artifacts: true

  artifacts:

    paths:

    - public

  only:

    - master

  except:

    variables:

      - $DOCUMENTATION_DISABLE || $PAGES_DISABLE

# 🔍 Coala

Auto-detect file in repo and run all [coala](https://coala.io) relevant linters on it.

**How to use it**

* Variables:

  * **TODO:** put variables from https://gitlab.com/go2scale/dockerfiles/quality-check here

**Specifications**

* File: https://gitlab.com/go2scale/jobs/raw/2020-03-05_3/jobs/quality_check.gitlab-ci.yml

* Publications:

    * Full report as artifact

    * Short report in merge request and job logs

* Image:

    * Repository: https://gitlab.com/go2scale/dockerfiles/quality-check

    * Documentation: https://go2scale.gitlab.io/dockerfiles/quality-check

# 📥 Build

*Work in progress...*