Skip to content

Commit

Permalink
FIX: CI
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderKaschta committed Feb 7, 2024
1 parent e2f7a4c commit a5e2b2d
Show file tree
Hide file tree
Showing 2 changed files with 96 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: ci
on:
push:
branches:
- main
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- uses: actions/setup-python@v5
with:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v4
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material
- run: mkdocs gh-deploy --force
68 changes: 68 additions & 0 deletions docs/file_formats.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# File formats

This file should give an overview over the different file formats used in MCP.

## Places and Locations

**File type** `JSON`

### Structure

```json title="Example file"
[
{
"name": "Karlsruhe-Innenstadt",
"addresses": [
{
"name": "Kaiserstraße",
"area": "Marktplatz",
"id": 1
},
{
"name": "Zirkel",
"area": "",
"id": 2
},
{
"name": "Karl-Friedrich-Straße",
"area": "",
"id": 3
}
],
"objects": [
{
"name": "Postgalerie",
"houseNumber": "217",
"description": "Einkaufszentrum",
"address": 1
}
]
}
]
```

## Mission Keywords

**File type** `CSV`

### Structure

```text
Keyword,Synonyms
Alkoholvergiftung,"Alkohol, C2, C2-Intox"
Fraktur,Knochenbruch
Schnittverletzung,
```

## Mission Resources

**File type** `CSV`

### Structure

```text
Name,Type
Auto A,KTW
Auto B,NKTW
Auto C,RTW
```

0 comments on commit a5e2b2d

Please sign in to comment.