Verified Commit 6d55ba21 authored by Lukas Wiest's avatar Lukas Wiest 🚂

chore: initial commit

parents
Pipeline #1776 failed with stages
in 1 minute and 37 seconds
# Editor configuration, see https://editorconfig.org
root = true
[*]
charset = utf-8
indent_style = space
indent_size = 4
insert_final_newline = true
trim_trailing_whitespace = true
[*.md]
max_line_length = off
trim_trailing_whitespace = false
# collected from https://github.com/github/gitignore/tree/master/Global
# ignore build output of docs
/site/
# ignore certain package pathes, dedicated for local playaround classes not to be committed
src/main/java/test/
*-local-settings.xml
# maven
target/
# python environment
env/
# Apple
.DS_Store
# VSCode
.vscode/
# NetBeans
**/nbproject/private/
**/nbproject/Makefile-*.mk
**/nbproject/Package-*.bash
build/
nbbuild/
dist/
nbdist/
.nb-gradle/
# IntelliJ
out/
.idea
*.iml
# Eclipse
.metadata
bin/
tmp/
*.tmp
*.bak
*.swp
*~.nib
local.properties
.settings/
.loadpath
.recommenders
.classpath
.project
# External tool builders
.externalToolBuilders/
# Locally stored "Eclipse launch configurations"
*.launch
# PyDev specific (Python IDE for Eclipse)
*.pydevproject
# CDT-specific (C/C++ Development Tooling)
.cproject
# CDT- autotools
.autotools
# Java annotation processor (APT)
.factorypath
# PDT-specific (PHP Development Tools)
.buildpath
# sbteclipse plugin
.target
# Tern plugin
.tern-project
# TeXlipse plugin
.texlipse
# STS (Spring Tool Suite)
.springBeans
# Code Recommenders
.recommenders/
# Annotation Processing
.apt_generated/
.apt_generated_test/
# Scala IDE specific (Scala & Java development for Eclipse)
.cache-main
.scala_dependencies
.worksheet
variables:
PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
cache:
paths:
- .cache/pip
- venv/
mkdocs:compile:
stage: compile
image: python:3.8
tags:
- docker
before_script:
- pip install virtualenv
- virtualenv venv
- source venv/bin/activate
script:
- pip install -r requirements.txt -U
- mkdocs build --strict
only:
changes:
- docs/**/*
- mkdocs.yml
artifacts:
expire_in: 3h
paths:
- site/
mkdocs:bundle:
stage: deploy
image: alpine
tags:
- docker
script:
- tar c -zvf documentation.tar.gz site
needs:
- mkdocs:compile
only:
changes:
- docs/**/*
- mkdocs.yml
artifacts:
expire_in: 3 days
paths:
- ./*.tar.gz
mkdocs:deploy:
stage: deploy
tags:
- production
variables:
EXPORT_DIR: "/var/www/html/pages"
PROJECT_NAME: "dtt"
script:
- mkdir -p "$EXPORT_DIR/$PROJECT_NAME"
- cp -r site/* "$EXPORT_DIR/$PROJECT_NAME"
needs:
- mkdocs:compile
only:
refs:
- disabled
changes:
- docs/**/*
- mkdocs.yml
stages:
- compile
- test
- deploy
include:
- local: '/.gitlab-ci-mkdocs.yml'
{
"tagPrefix": "",
"commitUrlFormat": "https://transfer.hft-stuttgart.de/gitlab/dtt/documentation/-/commit/{{hash}}",
"compareUrlFormat": "https://transfer.hft-stuttgart.de/gitlab/dtt/documentation/-/compare/{{previousTag}}...{{currentTag}}",
"issueUrlFormat": "https://transfer.hft-stuttgart.de/gitlab/dtt/documentation/-/issues/{{id}}"
}
# Dockerized Testing Toolkit
This is the documentation repository for the Dockerized Testing Toolkit (DTT).
Documentation for this is done with GitLab Pages using MkDocs and is available here:
_TBD_
If you don't want to open the Webpage or it is not available for whatever reason,
the documentation root is in [docs/index.md][docs-root]
[docs-root]: docs/index.md
# Changelog
!!! todo
Todo
# Contribution Index
!!! todo
add contribution guides
[![moodle-plugin][moodle-plugin-badge-latest-tag]][moodle-plugin-repo]
[![backend][backend-badge-latest-tag]][backend-repo]
[![License GPLv3][badge-gplv3]][gplv3]
[![Conventional Commits][badge-conventional-commits]][convcomm]
# Dockerized Testing Toolkit (DTT)
!!! warning "documentation under construction"
This documentation is in it's intial creation.
If a link leads back to the startpage, the requested site is not-yet written!
This is the documentation for the Dockerized Testing Toolkit, short DTT.
This toolkit provides the ability,
to write Unittests as a lecturer,
and have the students submissions run against them.
This is done by a Moodle Assign-Submission plugin,
where tests and submissions get set,
run by a backend service in an lecturer defined docker container
and results returned back to the moodle submission.
All information about the Moodle Plugin,
backend server,
testrunners
and how to make assignments and submissions are found in this documentation.
[convcomm]: https://conventionalcommits.org
[gplv3]: unified-ticketing/license-softlink.md
<!-- badges -->
[badge-conventional-commits]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-orange.svg
[badge-gplv3]: https://img.shields.io/badge/License-GPLv3-blue.svg
<!-- repos -->[backend-badge-latest-tag]: https://img.shields.io/badge/dynamic/json?color=success&label=backend-server&query=%24%5B0%5D.name&url=https%3A%2F%2Ftransfer.hft-stuttgart.de%2Fgitlab%2Fapi%2Fv4%2Fprojects%2F121%2Frepository%2Ftags%3Fper_page%3D1
[backend-repo]: https://transfer.hft-stuttgart.de/gitlab/dtt/backend
[moodle-plugin-badge-latest-tag]: https://img.shields.io/badge/dynamic/json?color=success&label=moodle-plugin&query=%24%5B0%5D.name&url=https%3A%2F%2Ftransfer.hft-stuttgart.de%2Fgitlab%2Fapi%2Fv4%2Fprojects%2F120%2Frepository%2Ftags%3Fper_page%3D1
[moodle-plugin-repo]: https://transfer.hft-stuttgart.de/gitlab/dtt/moodle-plugin
# License
!!! todo
Add License Information for the various parts
# Testrunner
!!! todo
write global information, list official available runners and link to their docs page
# Usage
!!! todo
Write usage guide for lecturers and students
site_name: Dockerized Testing Toolkit
docs_dir: docs
edit_uri: 'blob/master/docs/'
repo_name: 'Code on Transfer Portal'
repo_url: 'https://transfer.hft-stuttgart.de/gitlab/dtt/documentation'
copyright: 'Copyright &copy; 2020 University for Applied Sciences Stuttgart'
use_directory_urls: false
nav:
- Home:
- Index: 'index.md'
- Changelog: 'changelog.md'
- License: 'license.md'
- Usage: 'usage.md'
- Testrunner:
- Index: 'testrunner/index.md'
- Contribute:
- Index: 'contribute/index.md'
theme:
features:
- navigation.tabs
icon:
logo: material/book-open
language: 'en'
name: 'material'
palette:
accent: 'blue'
primary: 'red'
markdown_extensions:
- admonition
- attr_list
- footnotes
- markdown_del_ins
- plantuml_markdown:
format: svg
server: http://plantuml.com/plantuml
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight:
linenums: true
- pymdownx.superfences
- pymdownx.tabbed
- pymdownx.tasklist
- toc:
permalink: True
- tables
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment