diff --git a/.argo/application.yaml b/legacy/.argo/application.yaml similarity index 100% rename from .argo/application.yaml rename to legacy/.argo/application.yaml diff --git a/.argo/cert.yaml b/legacy/.argo/cert.yaml similarity index 100% rename from .argo/cert.yaml rename to legacy/.argo/cert.yaml diff --git a/.argo/deployment.yaml b/legacy/.argo/deployment.yaml similarity index 100% rename from .argo/deployment.yaml rename to legacy/.argo/deployment.yaml diff --git a/.argo/dns.yaml b/legacy/.argo/dns.yaml similarity index 100% rename from .argo/dns.yaml rename to legacy/.argo/dns.yaml diff --git a/.argo/ingress.yaml b/legacy/.argo/ingress.yaml similarity index 100% rename from .argo/ingress.yaml rename to legacy/.argo/ingress.yaml diff --git a/.argo/kustomization.yaml b/legacy/.argo/kustomization.yaml similarity index 100% rename from .argo/kustomization.yaml rename to legacy/.argo/kustomization.yaml diff --git a/.argo/service.yaml b/legacy/.argo/service.yaml similarity index 100% rename from .argo/service.yaml rename to legacy/.argo/service.yaml diff --git a/.dockerignore b/legacy/.dockerignore similarity index 100% rename from .dockerignore rename to legacy/.dockerignore diff --git a/.gitignore b/legacy/.gitignore similarity index 93% rename from .gitignore rename to legacy/.gitignore index 69a8bf0..95219a8 100644 --- a/.gitignore +++ b/legacy/.gitignore @@ -1,142 +1,142 @@ -# ---> VisualStudioCode -.vscode/* -!.vscode/settings.json -!.vscode/tasks.json -!.vscode/launch.json -!.vscode/extensions.json -!.vscode/i18n-ally-custom-framework.yml -*.code-workspace - -# Local History for Visual Studio Code -.history/ - -# ---> Node -# Logs -logs -*.log -npm-debug.log* -yarn-debug.log* -yarn-error.log* -lerna-debug.log* - -# Diagnostic reports (https://nodejs.org/api/report.html) -report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json - -# Runtime data -pids -*.pid -*.seed -*.pid.lock - -# Directory for instrumented libs generated by jscoverage/JSCover -lib-cov - -# Coverage directory used by tools like istanbul -coverage -*.lcov - -# nyc test coverage -.nyc_output - -# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) -.grunt - -# Bower dependency directory (https://bower.io/) -bower_components - -# node-waf configuration -.lock-wscript - -# Compiled binary addons (https://nodejs.org/api/addons.html) -build/Release - -# Dependency directories -node_modules/ -jspm_packages/ - -# Snowpack dependency directory (https://snowpack.dev/) -web_modules/ - -# TypeScript cache -*.tsbuildinfo - -# Optional npm cache directory -.npm - -# Optional eslint cache -.eslintcache - -# Microbundle cache -.rpt2_cache/ -.rts2_cache_cjs/ -.rts2_cache_es/ -.rts2_cache_umd/ - -# Optional REPL history -.node_repl_history - -# Output of 'npm pack' -*.tgz - -# Yarn Integrity file -.yarn-integrity - -# dotenv environment variables file -.env -.env.test - -# parcel-bundler cache (https://parceljs.org/) -.cache -.parcel-cache - -# Next.js build output -.next -out - -# Nuxt.js build / generate output -.nuxt -dist - -# Gatsby files -.cache/ -# Comment in the public line in if your project uses Gatsby and not Next.js -# https://nextjs.org/blog/next-9-1#public-directory-support -# public - -# vuepress build output -.vuepress/dist - -# Serverless directories -.serverless/ - -# FuseBox cache -.fusebox/ - -# DynamoDB Local files -.dynamodb/ - -# TernJS port file -.tern-port - -# Stores VSCode versions used for testing VSCode extensions -.vscode-test - -# yarn v2 -.yarn/cache -.yarn/unplugged -.yarn/build-state.yml -.yarn/install-state.gz -.pnp.* - -yarn.lock -package-lock.json -build - -*.sqlite -*.sqlite-jurnal -/docs -lib -/oss-attribution -*.tmp -pnpm-lock.yaml -.argo/secret.yaml +# ---> VisualStudioCode +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json +!.vscode/i18n-ally-custom-framework.yml +*.code-workspace + +# Local History for Visual Studio Code +.history/ + +# ---> Node +# Logs +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* +lerna-debug.log* + +# Diagnostic reports (https://nodejs.org/api/report.html) +report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json + +# Runtime data +pids +*.pid +*.seed +*.pid.lock + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage +*.lcov + +# nyc test coverage +.nyc_output + +# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# Bower dependency directory (https://bower.io/) +bower_components + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (https://nodejs.org/api/addons.html) +build/Release + +# Dependency directories +node_modules/ +jspm_packages/ + +# Snowpack dependency directory (https://snowpack.dev/) +web_modules/ + +# TypeScript cache +*.tsbuildinfo + +# Optional npm cache directory +.npm + +# Optional eslint cache +.eslintcache + +# Microbundle cache +.rpt2_cache/ +.rts2_cache_cjs/ +.rts2_cache_es/ +.rts2_cache_umd/ + +# Optional REPL history +.node_repl_history + +# Output of 'npm pack' +*.tgz + +# Yarn Integrity file +.yarn-integrity + +# dotenv environment variables file +.env +.env.test + +# parcel-bundler cache (https://parceljs.org/) +.cache +.parcel-cache + +# Next.js build output +.next +out + +# Nuxt.js build / generate output +.nuxt +dist + +# Gatsby files +.cache/ +# Comment in the public line in if your project uses Gatsby and not Next.js +# https://nextjs.org/blog/next-9-1#public-directory-support +# public + +# vuepress build output +.vuepress/dist + +# Serverless directories +.serverless/ + +# FuseBox cache +.fusebox/ + +# DynamoDB Local files +.dynamodb/ + +# TernJS port file +.tern-port + +# Stores VSCode versions used for testing VSCode extensions +.vscode-test + +# yarn v2 +.yarn/cache +.yarn/unplugged +.yarn/build-state.yml +.yarn/install-state.gz +.pnp.* + +yarn.lock +package-lock.json +build + +*.sqlite +*.sqlite-jurnal +/docs +lib +/oss-attribution +*.tmp +pnpm-lock.yaml +.argo/secret.yaml diff --git a/.npmignore b/legacy/.npmignore similarity index 100% rename from .npmignore rename to legacy/.npmignore diff --git a/.woodpecker/build.yml b/legacy/.woodpecker/build.yml similarity index 100% rename from .woodpecker/build.yml rename to legacy/.woodpecker/build.yml diff --git a/Dockerfile b/legacy/Dockerfile similarity index 97% rename from Dockerfile rename to legacy/Dockerfile index 7b09b40..52d9b21 100644 --- a/Dockerfile +++ b/legacy/Dockerfile @@ -1,14 +1,14 @@ -FROM registry.odit.services/hub/library/node:16-alpine3.16 AS build -ARG NPM_REGISTRY_URL=https://registry.npmjs.org -WORKDIR /app - -COPY package.json *.config.cjs *.config.js ./ -RUN npm config set registry $NPM_REGISTRY_URL && npm i -g pnpm@7.29.3 -RUN pnpm i -COPY . ./ -RUN pnpm build - -# final image -FROM registry.odit.services/library/nginx-brotli:latest -COPY --from=build /app/src/.vuepress/dist /usr/share/nginx/html +FROM registry.odit.services/hub/library/node:16-alpine3.16 AS build +ARG NPM_REGISTRY_URL=https://registry.npmjs.org +WORKDIR /app + +COPY package.json *.config.cjs *.config.js ./ +RUN npm config set registry $NPM_REGISTRY_URL && npm i -g pnpm@7.29.3 +RUN pnpm i +COPY . ./ +RUN pnpm build + +# final image +FROM registry.odit.services/library/nginx-brotli:latest +COPY --from=build /app/src/.vuepress/dist /usr/share/nginx/html COPY ./nginx.conf /etc/nginx/nginx.conf \ No newline at end of file diff --git a/README.md b/legacy/README.md similarity index 96% rename from README.md rename to legacy/README.md index 4b531b2..39ed696 100644 --- a/README.md +++ b/legacy/README.md @@ -1,34 +1,34 @@ -# @lfk/documentation - -The documentation for the LfK! 'Läufersystem'. -Powered by Vuepress. - -The main language for the content is German (since our primary target audience is the Lauf für Kaya! Team at a local German school). - -## Quickstart 🐳 -> Use this to run the documentation server via docker. - -1. Clone the repo or copy the docker-compose.yml -2. Cd into the folder containing the docker-compose.yml -2. Run docker-compose: `docker-compose up -d` -3. Visit http://127.0.0.1:8080/ to check if the server is running - -## Dev Setup 🛠 -> Local dev setup for previewing changes. - -1. Install Dependencies - ```bash - yarn - ``` -2. Start the server - ```bash - yarn dev - ``` - -## Recommended Editor - -[Visual Studio Code](https://code.visualstudio.com/) - -### Recommended Extensions - +# @lfk/documentation + +The documentation for the LfK! 'Läufersystem'. +Powered by Vuepress. + +The main language for the content is German (since our primary target audience is the Lauf für Kaya! Team at a local German school). + +## Quickstart 🐳 +> Use this to run the documentation server via docker. + +1. Clone the repo or copy the docker-compose.yml +2. Cd into the folder containing the docker-compose.yml +2. Run docker-compose: `docker-compose up -d` +3. Visit http://127.0.0.1:8080/ to check if the server is running + +## Dev Setup 🛠 +> Local dev setup for previewing changes. + +1. Install Dependencies + ```bash + yarn + ``` +2. Start the server + ```bash + yarn dev + ``` + +## Recommended Editor + +[Visual Studio Code](https://code.visualstudio.com/) + +### Recommended Extensions + * will be automatically recommended via ./vscode/extensions.json \ No newline at end of file diff --git a/docker-compose.yml b/legacy/docker-compose.yml similarity index 93% rename from docker-compose.yml rename to legacy/docker-compose.yml index f34b74a..54be4fa 100644 --- a/docker-compose.yml +++ b/legacy/docker-compose.yml @@ -1,6 +1,6 @@ -version: "3.3" -services: - httpd: - build: . - ports: +version: "3.3" +services: + httpd: + build: . + ports: - 8080:80 \ No newline at end of file diff --git a/licenses.md b/legacy/licenses.md similarity index 100% rename from licenses.md rename to legacy/licenses.md diff --git a/nginx.conf b/legacy/nginx.conf similarity index 97% rename from nginx.conf rename to legacy/nginx.conf index 2884dea..92040e3 100644 --- a/nginx.conf +++ b/legacy/nginx.conf @@ -1,47 +1,47 @@ - -events { -} -http { - include mime.types; - sendfile on; - server { - root /usr/share/nginx/html; - location / { - try_files $uri $uri/ /index.html; - } - - # --- Brotli - brotli on; - brotli_comp_level 6; - brotli_static on; - brotli_types application/atom+xml application/javascript application/json application/rss+xml application/vnd.ms-fontobject application/x-font-opentype application/x-font-truetype application/x-font-ttf application/x-javascript application/xhtml+xml application/xml font/eot font/opentype font/otf font/truetype image/svg+xml image/vnd.microsoft.icon image/x-icon image/x-win-bitmap text/css text/javascript text/plain text/xml; - # --- GZIP - gzip on; - gzip_disable "msie6"; - gzip_vary on; - gzip_proxied any; - gzip_comp_level 6; - gzip_buffers 16 8k; - gzip_http_version 1.1; - gzip_types application/javascript - application/rss+xml - application/vnd.ms-fontobject - application/x-font - application/x-font-opentype - application/x-font-otf - application/x-font-truetype - application/x-font-ttf - application/x-javascript - application/xhtml+xml - application/xml - font/opentype - font/otf - font/ttf - image/svg+xml - image/x-icon - text/css - text/javascript - text/plain - text/xml; - } + +events { +} +http { + include mime.types; + sendfile on; + server { + root /usr/share/nginx/html; + location / { + try_files $uri $uri/ /index.html; + } + + # --- Brotli + brotli on; + brotli_comp_level 6; + brotli_static on; + brotli_types application/atom+xml application/javascript application/json application/rss+xml application/vnd.ms-fontobject application/x-font-opentype application/x-font-truetype application/x-font-ttf application/x-javascript application/xhtml+xml application/xml font/eot font/opentype font/otf font/truetype image/svg+xml image/vnd.microsoft.icon image/x-icon image/x-win-bitmap text/css text/javascript text/plain text/xml; + # --- GZIP + gzip on; + gzip_disable "msie6"; + gzip_vary on; + gzip_proxied any; + gzip_comp_level 6; + gzip_buffers 16 8k; + gzip_http_version 1.1; + gzip_types application/javascript + application/rss+xml + application/vnd.ms-fontobject + application/x-font + application/x-font-opentype + application/x-font-otf + application/x-font-truetype + application/x-font-ttf + application/x-javascript + application/xhtml+xml + application/xml + font/opentype + font/otf + font/ttf + image/svg+xml + image/x-icon + text/css + text/javascript + text/plain + text/xml; + } } \ No newline at end of file diff --git a/package.json b/legacy/package.json similarity index 100% rename from package.json rename to legacy/package.json diff --git a/src/.vuepress/components/Foo/Bar.vue b/legacy/src/.vuepress/components/Foo/Bar.vue similarity index 100% rename from src/.vuepress/components/Foo/Bar.vue rename to legacy/src/.vuepress/components/Foo/Bar.vue diff --git a/src/.vuepress/components/OtherComponent.vue b/legacy/src/.vuepress/components/OtherComponent.vue similarity index 100% rename from src/.vuepress/components/OtherComponent.vue rename to legacy/src/.vuepress/components/OtherComponent.vue diff --git a/src/.vuepress/components/demo-component.vue b/legacy/src/.vuepress/components/demo-component.vue similarity index 100% rename from src/.vuepress/components/demo-component.vue rename to legacy/src/.vuepress/components/demo-component.vue diff --git a/src/.vuepress/config.js b/legacy/src/.vuepress/config.js similarity index 100% rename from src/.vuepress/config.js rename to legacy/src/.vuepress/config.js diff --git a/src/.vuepress/enhanceApp.js b/legacy/src/.vuepress/enhanceApp.js similarity index 100% rename from src/.vuepress/enhanceApp.js rename to legacy/src/.vuepress/enhanceApp.js diff --git a/src/.vuepress/public/files/class_with_middlename.csv b/legacy/src/.vuepress/public/files/class_with_middlename.csv similarity index 100% rename from src/.vuepress/public/files/class_with_middlename.csv rename to legacy/src/.vuepress/public/files/class_with_middlename.csv diff --git a/src/.vuepress/public/files/class_with_middlename.xlsx b/legacy/src/.vuepress/public/files/class_with_middlename.xlsx similarity index 100% rename from src/.vuepress/public/files/class_with_middlename.xlsx rename to legacy/src/.vuepress/public/files/class_with_middlename.xlsx diff --git a/src/.vuepress/public/files/class_without_middlename.csv b/legacy/src/.vuepress/public/files/class_without_middlename.csv similarity index 100% rename from src/.vuepress/public/files/class_without_middlename.csv rename to legacy/src/.vuepress/public/files/class_without_middlename.csv diff --git a/src/.vuepress/public/files/class_without_middlename.xlsx b/legacy/src/.vuepress/public/files/class_without_middlename.xlsx similarity index 100% rename from src/.vuepress/public/files/class_without_middlename.xlsx rename to legacy/src/.vuepress/public/files/class_without_middlename.xlsx diff --git a/src/.vuepress/public/files/scannerconfig.docx b/legacy/src/.vuepress/public/files/scannerconfig.docx similarity index 100% rename from src/.vuepress/public/files/scannerconfig.docx rename to legacy/src/.vuepress/public/files/scannerconfig.docx diff --git a/src/.vuepress/public/files/scannerconfig.pdf b/legacy/src/.vuepress/public/files/scannerconfig.pdf similarity index 100% rename from src/.vuepress/public/files/scannerconfig.pdf rename to legacy/src/.vuepress/public/files/scannerconfig.pdf diff --git a/src/.vuepress/public/images/barcode_config/00_factory_reset.png b/legacy/src/.vuepress/public/images/barcode_config/00_factory_reset.png similarity index 100% rename from src/.vuepress/public/images/barcode_config/00_factory_reset.png rename to legacy/src/.vuepress/public/images/barcode_config/00_factory_reset.png diff --git a/src/.vuepress/public/images/barcode_config/01_programming-mode.png b/legacy/src/.vuepress/public/images/barcode_config/01_programming-mode.png similarity index 100% rename from src/.vuepress/public/images/barcode_config/01_programming-mode.png rename to legacy/src/.vuepress/public/images/barcode_config/01_programming-mode.png diff --git a/src/.vuepress/public/images/barcode_config/02_disable_all.png b/legacy/src/.vuepress/public/images/barcode_config/02_disable_all.png similarity index 100% rename from src/.vuepress/public/images/barcode_config/02_disable_all.png rename to legacy/src/.vuepress/public/images/barcode_config/02_disable_all.png diff --git a/src/.vuepress/public/images/barcode_config/03_enable_ean.png b/legacy/src/.vuepress/public/images/barcode_config/03_enable_ean.png similarity index 100% rename from src/.vuepress/public/images/barcode_config/03_enable_ean.png rename to legacy/src/.vuepress/public/images/barcode_config/03_enable_ean.png diff --git a/src/.vuepress/public/images/barcode_config/04_check_ean_digit.png b/legacy/src/.vuepress/public/images/barcode_config/04_check_ean_digit.png similarity index 100% rename from src/.vuepress/public/images/barcode_config/04_check_ean_digit.png rename to legacy/src/.vuepress/public/images/barcode_config/04_check_ean_digit.png diff --git a/src/.vuepress/public/images/barcode_config/05_disable_ean_digit.png b/legacy/src/.vuepress/public/images/barcode_config/05_disable_ean_digit.png similarity index 100% rename from src/.vuepress/public/images/barcode_config/05_disable_ean_digit.png rename to legacy/src/.vuepress/public/images/barcode_config/05_disable_ean_digit.png diff --git a/src/.vuepress/public/images/barcode_config/06_always_on.png b/legacy/src/.vuepress/public/images/barcode_config/06_always_on.png similarity index 100% rename from src/.vuepress/public/images/barcode_config/06_always_on.png rename to legacy/src/.vuepress/public/images/barcode_config/06_always_on.png diff --git a/src/.vuepress/public/images/barcode_config/07_beep_off.png b/legacy/src/.vuepress/public/images/barcode_config/07_beep_off.png similarity index 100% rename from src/.vuepress/public/images/barcode_config/07_beep_off.png rename to legacy/src/.vuepress/public/images/barcode_config/07_beep_off.png diff --git a/src/.vuepress/public/images/barcode_config/08_countrycode_germany.png b/legacy/src/.vuepress/public/images/barcode_config/08_countrycode_germany.png similarity index 100% rename from src/.vuepress/public/images/barcode_config/08_countrycode_germany.png rename to legacy/src/.vuepress/public/images/barcode_config/08_countrycode_germany.png diff --git a/src/.vuepress/public/images/runner_import_excel_no_middlename.png b/legacy/src/.vuepress/public/images/runner_import_excel_no_middlename.png similarity index 100% rename from src/.vuepress/public/images/runner_import_excel_no_middlename.png rename to legacy/src/.vuepress/public/images/runner_import_excel_no_middlename.png diff --git a/src/.vuepress/public/images/runner_import_excel_with_middlename.png b/legacy/src/.vuepress/public/images/runner_import_excel_with_middlename.png similarity index 100% rename from src/.vuepress/public/images/runner_import_excel_with_middlename.png rename to legacy/src/.vuepress/public/images/runner_import_excel_with_middlename.png diff --git a/src/.vuepress/public/images/service_interaction.png b/legacy/src/.vuepress/public/images/service_interaction.png similarity index 100% rename from src/.vuepress/public/images/service_interaction.png rename to legacy/src/.vuepress/public/images/service_interaction.png diff --git a/src/.vuepress/public/logo.png b/legacy/src/.vuepress/public/logo.png similarity index 100% rename from src/.vuepress/public/logo.png rename to legacy/src/.vuepress/public/logo.png diff --git a/src/.vuepress/styles/index.styl b/legacy/src/.vuepress/styles/index.styl similarity index 100% rename from src/.vuepress/styles/index.styl rename to legacy/src/.vuepress/styles/index.styl diff --git a/src/.vuepress/styles/palette.styl b/legacy/src/.vuepress/styles/palette.styl similarity index 100% rename from src/.vuepress/styles/palette.styl rename to legacy/src/.vuepress/styles/palette.styl diff --git a/src/admins/README.md b/legacy/src/admins/README.md similarity index 100% rename from src/admins/README.md rename to legacy/src/admins/README.md diff --git a/src/admins/quickstart.md b/legacy/src/admins/quickstart.md similarity index 98% rename from src/admins/quickstart.md rename to legacy/src/admins/quickstart.md index bee7dbc..1d173c1 100644 --- a/src/admins/quickstart.md +++ b/legacy/src/admins/quickstart.md @@ -1,19 +1,19 @@ -# Schnellstart -> Du willst das System schnell aufsetzen und testen? Dann bist du hier genau richtig! -> Um das System für produktive Zwecke einzusetzen schau dir bitte die Installationsanleitung an. - -## Voraussetzungen -Alle der folgenden Anleitungen gehen davon aus, dass du bereits Docker und Docker-Compose installiert hast. -Die Installationsanleitungen dafür findest du hier: -* [Docker](https://docs.docker.com/get-docker/) -* [Docker-Compose](https://docs.docker.com/compose/install/) - -## Das ganze System -> Du willst das ganze System (backend, fronten, document-server) schnell aufsetzen. - -1. Klone das lfk/deployment git repo von: https://git.odit.services/lfk/deployment (oder lade es herunter) -2. Navigiere nach `docker-compose/full_stack`: `cd deployment/docker-compose/full_stack` -3. Starte das System mit `docker-compose up` -4. Nachdem alles gestartet ist ist kannst du das Frontend aufrufen: http://localhost:4010 (backend: http://localhost:4010/api/, document-server: http://localhost:4010/documents/) - +# Schnellstart +> Du willst das System schnell aufsetzen und testen? Dann bist du hier genau richtig! +> Um das System für produktive Zwecke einzusetzen schau dir bitte die Installationsanleitung an. + +## Voraussetzungen +Alle der folgenden Anleitungen gehen davon aus, dass du bereits Docker und Docker-Compose installiert hast. +Die Installationsanleitungen dafür findest du hier: +* [Docker](https://docs.docker.com/get-docker/) +* [Docker-Compose](https://docs.docker.com/compose/install/) + +## Das ganze System +> Du willst das ganze System (backend, fronten, document-server) schnell aufsetzen. + +1. Klone das lfk/deployment git repo von: https://git.odit.services/lfk/deployment (oder lade es herunter) +2. Navigiere nach `docker-compose/full_stack`: `cd deployment/docker-compose/full_stack` +3. Starte das System mit `docker-compose up` +4. Nachdem alles gestartet ist ist kannst du das Frontend aufrufen: http://localhost:4010 (backend: http://localhost:4010/api/, document-server: http://localhost:4010/documents/) + Bei Bedarf können die Ports und andere Einstellungen im docker-compose.yml angepasst werden. \ No newline at end of file diff --git a/src/admins/usergroups.md b/legacy/src/admins/usergroups.md similarity index 100% rename from src/admins/usergroups.md rename to legacy/src/admins/usergroups.md diff --git a/src/admins/users.md b/legacy/src/admins/users.md similarity index 100% rename from src/admins/users.md rename to legacy/src/admins/users.md diff --git a/src/beamershow/README.md b/legacy/src/beamershow/README.md similarity index 100% rename from src/beamershow/README.md rename to legacy/src/beamershow/README.md diff --git a/src/beamershow/config.md b/legacy/src/beamershow/config.md similarity index 100% rename from src/beamershow/config.md rename to legacy/src/beamershow/config.md diff --git a/src/en/admins/README.md b/legacy/src/en/admins/README.md similarity index 100% rename from src/en/admins/README.md rename to legacy/src/en/admins/README.md diff --git a/src/en/index.md b/legacy/src/en/index.md similarity index 100% rename from src/en/index.md rename to legacy/src/en/index.md diff --git a/src/en/users/README.md b/legacy/src/en/users/README.md similarity index 100% rename from src/en/users/README.md rename to legacy/src/en/users/README.md diff --git a/src/index.md b/legacy/src/index.md similarity index 100% rename from src/index.md rename to legacy/src/index.md diff --git a/src/scanstations/README.md b/legacy/src/scanstations/README.md similarity index 100% rename from src/scanstations/README.md rename to legacy/src/scanstations/README.md diff --git a/src/scanstations/config.md b/legacy/src/scanstations/config.md similarity index 100% rename from src/scanstations/config.md rename to legacy/src/scanstations/config.md diff --git a/src/scanstations/config_scanners.md b/legacy/src/scanstations/config_scanners.md similarity index 97% rename from src/scanstations/config_scanners.md rename to legacy/src/scanstations/config_scanners.md index 5ec681a..58feb1b 100644 --- a/src/scanstations/config_scanners.md +++ b/legacy/src/scanstations/config_scanners.md @@ -1,31 +1,31 @@ -# Scannerkonfiguration -> Achtung: Diese Konfiguratiuon wurde nur mit GD4130-BK/WH USB Scannern getestet -> Download als PDF: [Scannerkonfiguration.pdf](/files/scannerconfig.pdf) - -## 1. Werkseinstellungen wiederherstellen -![Factory reset](/images/barcode_config/00_factory_reset.png) - -## 2. Programming Mode Aktivieren -![Enter/Exit Programming Mode](/images/barcode_config/01_programming-mode.png) - -## 3. Nur EAN-13 scannen (optional) -![Check EAN Checkdigit](/images/barcode_config/02_disable_all.png) -![Disable EAN Checkdigit](/images/barcode_config/03_enable_ean.png) - -## 4. EAN13 Check-Zahl überprüfen, aber nicht übertragen -![Disable EAN Checkdigit](/images/barcode_config/05_disable_ean_digit.png) - -## 5. Scanner auf always on stellen (optional) -![Scan mode: Always on](/images/barcode_config/06_always_on.png) -## 6. Programming Mode Verlassen -![Enter/Exit Programming Mode](/images/barcode_config/01_programming-mode.png) - -## 7. Beep ausschalten (optional) -![Enter/Exit Programming Mode](/images/barcode_config/01_programming-mode.png) -![Scan mode: Always on](/images/barcode_config/07_beep_off.png) -![Enter/Exit Programming Mode](/images/barcode_config/01_programming-mode.png) - -## 8. Tastatur auf Deutsch stellen (optional) -![Enter/Exit Programming Mode](/images/barcode_config/01_programming-mode.png) -![Country Mode: Germany](/images/barcode_config/08_countrycode_germany.png) -![Enter/Exit Programming Mode](/images/barcode_config/01_programming-mode.png) +# Scannerkonfiguration +> Achtung: Diese Konfiguratiuon wurde nur mit GD4130-BK/WH USB Scannern getestet +> Download als PDF: [Scannerkonfiguration.pdf](/files/scannerconfig.pdf) + +## 1. Werkseinstellungen wiederherstellen +![Factory reset](/images/barcode_config/00_factory_reset.png) + +## 2. Programming Mode Aktivieren +![Enter/Exit Programming Mode](/images/barcode_config/01_programming-mode.png) + +## 3. Nur EAN-13 scannen (optional) +![Check EAN Checkdigit](/images/barcode_config/02_disable_all.png) +![Disable EAN Checkdigit](/images/barcode_config/03_enable_ean.png) + +## 4. EAN13 Check-Zahl überprüfen, aber nicht übertragen +![Disable EAN Checkdigit](/images/barcode_config/05_disable_ean_digit.png) + +## 5. Scanner auf always on stellen (optional) +![Scan mode: Always on](/images/barcode_config/06_always_on.png) +## 6. Programming Mode Verlassen +![Enter/Exit Programming Mode](/images/barcode_config/01_programming-mode.png) + +## 7. Beep ausschalten (optional) +![Enter/Exit Programming Mode](/images/barcode_config/01_programming-mode.png) +![Scan mode: Always on](/images/barcode_config/07_beep_off.png) +![Enter/Exit Programming Mode](/images/barcode_config/01_programming-mode.png) + +## 8. Tastatur auf Deutsch stellen (optional) +![Enter/Exit Programming Mode](/images/barcode_config/01_programming-mode.png) +![Country Mode: Germany](/images/barcode_config/08_countrycode_germany.png) +![Enter/Exit Programming Mode](/images/barcode_config/01_programming-mode.png) diff --git a/src/scanstations/hardware.md b/legacy/src/scanstations/hardware.md similarity index 97% rename from src/scanstations/hardware.md rename to legacy/src/scanstations/hardware.md index 64e6d5a..9e4e544 100644 --- a/src/scanstations/hardware.md +++ b/legacy/src/scanstations/hardware.md @@ -1,12 +1,12 @@ -# Hardwareempfehlungen -> Known-good Hardware, die wir für die Scannerstationen empfehlen können - -## Computer -* Raspberry Pi 3 oder neuer -* Prozessor: Minimum: Intel Core 2 Duo -* Arbeitsspeicher: Minimum 4GB - -## Barcodescanner -* Datalogic Gryphon GD4130-BK/WH USB Scanner (1D) -* Datalogic Gryphon GD4200 USB Scanner (1D) +# Hardwareempfehlungen +> Known-good Hardware, die wir für die Scannerstationen empfehlen können + +## Computer +* Raspberry Pi 3 oder neuer +* Prozessor: Minimum: Intel Core 2 Duo +* Arbeitsspeicher: Minimum 4GB + +## Barcodescanner +* Datalogic Gryphon GD4130-BK/WH USB Scanner (1D) +* Datalogic Gryphon GD4200 USB Scanner (1D) * Datalogic Gryphon GD4400 USB Scanner (2D) \ No newline at end of file diff --git a/src/scanstations/install.md b/legacy/src/scanstations/install.md similarity index 100% rename from src/scanstations/install.md rename to legacy/src/scanstations/install.md diff --git a/src/selfservice/README.md b/legacy/src/selfservice/README.md similarity index 100% rename from src/selfservice/README.md rename to legacy/src/selfservice/README.md diff --git a/src/selfservice/org_selfservice.md b/legacy/src/selfservice/org_selfservice.md similarity index 100% rename from src/selfservice/org_selfservice.md rename to legacy/src/selfservice/org_selfservice.md diff --git a/src/users/README.md b/legacy/src/users/README.md similarity index 100% rename from src/users/README.md rename to legacy/src/users/README.md diff --git a/src/users/accounts.md b/legacy/src/users/accounts.md similarity index 100% rename from src/users/accounts.md rename to legacy/src/users/accounts.md diff --git a/src/users/cards.md b/legacy/src/users/cards.md similarity index 100% rename from src/users/cards.md rename to legacy/src/users/cards.md diff --git a/src/users/contacts.md b/legacy/src/users/contacts.md similarity index 100% rename from src/users/contacts.md rename to legacy/src/users/contacts.md diff --git a/src/users/donations.md b/legacy/src/users/donations.md similarity index 100% rename from src/users/donations.md rename to legacy/src/users/donations.md diff --git a/src/users/donors.md b/legacy/src/users/donors.md similarity index 100% rename from src/users/donors.md rename to legacy/src/users/donors.md diff --git a/src/users/organizations.md b/legacy/src/users/organizations.md similarity index 98% rename from src/users/organizations.md rename to legacy/src/users/organizations.md index 6507373..7877e93 100644 --- a/src/users/organizations.md +++ b/legacy/src/users/organizations.md @@ -1,36 +1,36 @@ -# Organisationen -> Solltest du dich für den Selfservice für Orgs interessieren findest du die Dokumentation zu hier - -Läuferorganisationen sind das Herzstück des Gruppensystems für Läufer. -Eine Organisation kann eine Firma, Schule, Kindergarten, Verein oder ähnliches sein. - -Läufer:innen können direkt einer Organisation zugeordnet werden. -Um die Läufer:innen einer Organisation (z.B.: Schule) weiter zu sortieren können einer Organisation mehrere Teams (z.B.: Klassen) zugeordnet werden. -Einer/m Organisation/Team kann ein Kontakt zugeordnet werden, mehr dazu findest du hier. -Mehr zu Teams findest du hier - -## Anlegen -Um eine neue Organisation anzulegen öffne im Läufersystem die Seite `Orgs`. -Über den Button `Organisation erstellen` kannst du eine neue Organisation erstellen. -Dabei kannst du der Organisation einen Namen geben. - -## Bearbeiten -Um eine Organisation zu bearbeiten kannst du in der Organisationsübersicht den Button `Details` für die gewünschte Organisation anklicken. -In der Übersicht für diese Organisation kannst du nun den Namen der Organisation und den zugewiesenen Kontakt ändern. -Wenn du fertig bist klick einfach auf `Änderungen speichern`. - -## Löschen -> Du kannst eine Organisation entweder aus der Organisationsübersicht oder der Organisationsdetailansicht löschen. - -### In der Organisationsübersicht -Klick bei der gewünschten Organisation auf den Button `Löschen`. -Daraufhin wirst du gefragt, ob du die Organisation wirklich löschen oder abbrechen willst. - -### In der Organisationsdetailansicht -Klick bei der gewünschten Organisation auf den Button `Details`. -Oben auf der Seite gibt es jetzt den Knopf `Organisation löschen`. -Daraufhin wirst du gefragt, ob du die Organisation wirklich löschen oder abbrechen willst. - -### Organisation mit Teams und Läufer -Sollte die Organisation noch Teams und/oder Läufer haben geht nach dem Bestätigen der Löschung nochmal eine Warnung auf. +# Organisationen +> Solltest du dich für den Selfservice für Orgs interessieren findest du die Dokumentation zu hier + +Läuferorganisationen sind das Herzstück des Gruppensystems für Läufer. +Eine Organisation kann eine Firma, Schule, Kindergarten, Verein oder ähnliches sein. + +Läufer:innen können direkt einer Organisation zugeordnet werden. +Um die Läufer:innen einer Organisation (z.B.: Schule) weiter zu sortieren können einer Organisation mehrere Teams (z.B.: Klassen) zugeordnet werden. +Einer/m Organisation/Team kann ein Kontakt zugeordnet werden, mehr dazu findest du hier. +Mehr zu Teams findest du hier + +## Anlegen +Um eine neue Organisation anzulegen öffne im Läufersystem die Seite `Orgs`. +Über den Button `Organisation erstellen` kannst du eine neue Organisation erstellen. +Dabei kannst du der Organisation einen Namen geben. + +## Bearbeiten +Um eine Organisation zu bearbeiten kannst du in der Organisationsübersicht den Button `Details` für die gewünschte Organisation anklicken. +In der Übersicht für diese Organisation kannst du nun den Namen der Organisation und den zugewiesenen Kontakt ändern. +Wenn du fertig bist klick einfach auf `Änderungen speichern`. + +## Löschen +> Du kannst eine Organisation entweder aus der Organisationsübersicht oder der Organisationsdetailansicht löschen. + +### In der Organisationsübersicht +Klick bei der gewünschten Organisation auf den Button `Löschen`. +Daraufhin wirst du gefragt, ob du die Organisation wirklich löschen oder abbrechen willst. + +### In der Organisationsdetailansicht +Klick bei der gewünschten Organisation auf den Button `Details`. +Oben auf der Seite gibt es jetzt den Knopf `Organisation löschen`. +Daraufhin wirst du gefragt, ob du die Organisation wirklich löschen oder abbrechen willst. + +### Organisation mit Teams und Läufer +Sollte die Organisation noch Teams und/oder Läufer haben geht nach dem Bestätigen der Löschung nochmal eine Warnung auf. Hier musst du nochmal die Löschung inklusive aller Läufer und Teams bestätigen, alternativ kannst du auch Abbrechen. \ No newline at end of file diff --git a/src/users/runner_import.md b/legacy/src/users/runner_import.md similarity index 98% rename from src/users/runner_import.md rename to legacy/src/users/runner_import.md index 45c38c2..4edcb7a 100644 --- a/src/users/runner_import.md +++ b/legacy/src/users/runner_import.md @@ -1,109 +1,109 @@ -# Läuferimport - -Um das Eintragen von Läufer:innen ins System zu erleichtern können Läufer aus Excel-Tabellen(CSV, XLSX) importiert werden. -Diese Funktion ist vor allem für Schulen und Kindergärten gedacht, kann aber natürlich für alle Arten von Teams und Organisationen verwendet werden. -Im Folgenden erklären wir dir Schritt für Schritt, wie du Läufer ins System importieren kannst. - -## Aufbau der Importdateien -> Die Datei muss im Format XLSX(Excel) oder CSV vorliegen - -Alle Läufer müssen auf einem "Tabellenblatt"(Excel) stehen, alle weiteren Tabellenblätter werden ignoriert. -Die Tabelle muss folgendem Schema folgen: -Vorname | Mittelname | Nachname | Team/Klasse -- | - | - | - -Vorname1 | Optional | Nachname1 | Optional - -Achtung: Die Team Spalte kann Team oder Klasse heißen! - -### Beispiel: CSV - -**Mit Mittelname** -> [Beispieldatei herunterladen](/files/class_with_middlename.csv) - -``` -Vorname; Mittelname; Nachname; Team; -Peter; ; Tester; 1A -Manuel; Steffen; Regenwald; 1A -Toller; ; Typ; 2A -``` - -**Ohne Mittelname** -> [Beispieldatei herunterladen](/files/class_without_middlename.csv) - -``` -Vorname; Nachname; Team; -Peter; Tester; 1A -Manuel; Regenwald; 1A -Toller; Typ; 2A -``` - -### Beispiel: XLSX (Excel) -**Mit Mittelname** -> [Beispieldatei herunterladen](/files/class_with_middlename.xlsx) - -![Excel Screenshot with Middlename](/images/runner_import_excel_with_middlename.png) - - -**Ohne Mittelname** -> [Beispieldatei herunterladen](/files/class_without_middlename.xlsx) - -![Excel Screenshot with Middlename](/images/runner_import_excel_no_middlename.png) - -## Import in eine Organisation -> Wähle diese Variante, wenn du in einer Organisation automatisch Teams anlegen und die Läufer in diese Importieren willst.
-> Wähle diese Variante, wenn du Läufer direkt in eine Organisation importieren willst. - -Wenn in der Datei bei einer Läufer:in kein Team angegeben ist wird sie direkt in die Organisation importiert. -Ist ein Team angegeben wird das Team in der Organisation gesucht und neu Angelegt, wenn es nicht gefunden wurde - danach wird die Läufer:in in das Team importiert. - -### Aus der Organisationsübersicht -1. Öffne im Läufersystem die Seite `Orgs` -2. Klicke oben auf `Läufer importieren` -3. Klicke auf `Datei auswählen` und wähle die Datei aus, aus der du Läufer:innen importieren willst -4. Dir wird eine Übersicht aller Läufer:innen angezeigt, die in der Datei gefunden wurden - überprüfe alle Läufer:innen auf Korrektheit -5. Wähle oben die Organisation aus, in die die Läufer:innen importiert werden sollen -6. Klicke unten auf `Läufer importieren`, um die Läufer:innen zu importieren oder `Abbrechen`, um den Import abzubrechen -7. Die Läufer werden nun in die Organisation importiert - -### Aus der Organisationsdetailansicht -1. Öffne im Läufersystem die Seite `Orgs` -2. Klicke bei der gewünschten Organisation auf den `Details` Button -3. Klicke oben auf `Läufer importieren` -4. Klicke auf `Datei auswählen` und wähle die Datei aus, aus der du Läufer:innen importieren willst -5. Dir wird eine Übersicht aller Läufer:innen angezeigt, die in der Datei gefunden wurden - überprüfe alle Läufer:innen auf Korrektheit -6. Wähle oben die Organisation aus, in die die Läufer:innen importiert werden sollen -7. Klicke unten auf `Läufer importieren`, um die Läufer:innen zu importieren oder `Abbrechen`, um den Import abzubrechen -8. Die Läufer werden nun in die Organisation importiert - -### Aus der Läuferübersicht -1. Öffne im Läufersystem die Seite `Läufer` -2. Klicke oben auf `Läufer importieren` -3. Klicke auf `Datei auswählen` und wähle die Datei aus, aus der du Läufer:innen importieren willst -4. Dir wird eine Übersicht aller Läufer:innen angezeigt, die in der Datei gefunden wurden - überprüfe alle Läufer:innen auf Korrektheit -5. Wähle oben die Organisation (Hat kein `>` im Namen) aus, in die die Läufer:innen importiert werden sollen -6. Klicke unten auf `Läufer importieren`, um die Läufer:innen zu importieren oder `Abbrechen`, um den Import abzubrechen -7. Die Läufer werden nun in die Organisation importiert - -## Import in ein Team -> Wähle diese Variante, wenn du Läufer direkt in ein Team importieren willst. - -Wenn in der Datei bei einer Läufer:in ein Team angegeben ist wird dieses ignoriert und mit dem gewählten Team überschrieben.. - -### Aus der Teamdetailansicht -1. Öffne im Läufersystem die Seite `Teams` -2. Klicke bei de, gewünschten Team auf den `Details` Button -3. Klicke oben auf `Läufer importieren` -4. Klicke auf `Datei auswählen` und wähle die Datei aus, aus der du Läufer:innen importieren willst -5. Dir wird eine Übersicht aller Läufer:innen angezeigt, die in der Datei gefunden wurden - überprüfe alle Läufer:innen auf Korrektheit -6. Wähle oben das Team aus, in die die Läufer:innen importiert werden sollen -7. Klicke unten auf `Läufer importieren`, um die Läufer:innen zu importieren oder `Abbrechen`, um den Import abzubrechen -8. Die Läufer werden nun in das Team importiert - -### Aus der Läuferübersicht -1. Öffne im Läufersystem die Seite `Läufer` -2. Klicke oben auf `Läufer importieren` -3. Klicke auf `Datei auswählen` und wähle die Datei aus, aus der du Läufer:innen importieren willst -4. Dir wird eine Übersicht aller Läufer:innen angezeigt, die in der Datei gefunden wurden - überprüfe alle Läufer:innen auf Korrektheit -5. Wähle oben das Team (Hat ein `>` im Namen) aus, in die die Läufer:innen importiert werden sollen -6. Klicke unten auf `Läufer importieren`, um die Läufer:innen zu importieren oder `Abbrechen`, um den Import abzubrechen +# Läuferimport + +Um das Eintragen von Läufer:innen ins System zu erleichtern können Läufer aus Excel-Tabellen(CSV, XLSX) importiert werden. +Diese Funktion ist vor allem für Schulen und Kindergärten gedacht, kann aber natürlich für alle Arten von Teams und Organisationen verwendet werden. +Im Folgenden erklären wir dir Schritt für Schritt, wie du Läufer ins System importieren kannst. + +## Aufbau der Importdateien +> Die Datei muss im Format XLSX(Excel) oder CSV vorliegen + +Alle Läufer müssen auf einem "Tabellenblatt"(Excel) stehen, alle weiteren Tabellenblätter werden ignoriert. +Die Tabelle muss folgendem Schema folgen: +Vorname | Mittelname | Nachname | Team/Klasse +- | - | - | - +Vorname1 | Optional | Nachname1 | Optional + +Achtung: Die Team Spalte kann Team oder Klasse heißen! + +### Beispiel: CSV + +**Mit Mittelname** +> [Beispieldatei herunterladen](/files/class_with_middlename.csv) + +``` +Vorname; Mittelname; Nachname; Team; +Peter; ; Tester; 1A +Manuel; Steffen; Regenwald; 1A +Toller; ; Typ; 2A +``` + +**Ohne Mittelname** +> [Beispieldatei herunterladen](/files/class_without_middlename.csv) + +``` +Vorname; Nachname; Team; +Peter; Tester; 1A +Manuel; Regenwald; 1A +Toller; Typ; 2A +``` + +### Beispiel: XLSX (Excel) +**Mit Mittelname** +> [Beispieldatei herunterladen](/files/class_with_middlename.xlsx) + +![Excel Screenshot with Middlename](/images/runner_import_excel_with_middlename.png) + + +**Ohne Mittelname** +> [Beispieldatei herunterladen](/files/class_without_middlename.xlsx) + +![Excel Screenshot with Middlename](/images/runner_import_excel_no_middlename.png) + +## Import in eine Organisation +> Wähle diese Variante, wenn du in einer Organisation automatisch Teams anlegen und die Läufer in diese Importieren willst.
+> Wähle diese Variante, wenn du Läufer direkt in eine Organisation importieren willst. + +Wenn in der Datei bei einer Läufer:in kein Team angegeben ist wird sie direkt in die Organisation importiert. +Ist ein Team angegeben wird das Team in der Organisation gesucht und neu Angelegt, wenn es nicht gefunden wurde - danach wird die Läufer:in in das Team importiert. + +### Aus der Organisationsübersicht +1. Öffne im Läufersystem die Seite `Orgs` +2. Klicke oben auf `Läufer importieren` +3. Klicke auf `Datei auswählen` und wähle die Datei aus, aus der du Läufer:innen importieren willst +4. Dir wird eine Übersicht aller Läufer:innen angezeigt, die in der Datei gefunden wurden - überprüfe alle Läufer:innen auf Korrektheit +5. Wähle oben die Organisation aus, in die die Läufer:innen importiert werden sollen +6. Klicke unten auf `Läufer importieren`, um die Läufer:innen zu importieren oder `Abbrechen`, um den Import abzubrechen +7. Die Läufer werden nun in die Organisation importiert + +### Aus der Organisationsdetailansicht +1. Öffne im Läufersystem die Seite `Orgs` +2. Klicke bei der gewünschten Organisation auf den `Details` Button +3. Klicke oben auf `Läufer importieren` +4. Klicke auf `Datei auswählen` und wähle die Datei aus, aus der du Läufer:innen importieren willst +5. Dir wird eine Übersicht aller Läufer:innen angezeigt, die in der Datei gefunden wurden - überprüfe alle Läufer:innen auf Korrektheit +6. Wähle oben die Organisation aus, in die die Läufer:innen importiert werden sollen +7. Klicke unten auf `Läufer importieren`, um die Läufer:innen zu importieren oder `Abbrechen`, um den Import abzubrechen +8. Die Läufer werden nun in die Organisation importiert + +### Aus der Läuferübersicht +1. Öffne im Läufersystem die Seite `Läufer` +2. Klicke oben auf `Läufer importieren` +3. Klicke auf `Datei auswählen` und wähle die Datei aus, aus der du Läufer:innen importieren willst +4. Dir wird eine Übersicht aller Läufer:innen angezeigt, die in der Datei gefunden wurden - überprüfe alle Läufer:innen auf Korrektheit +5. Wähle oben die Organisation (Hat kein `>` im Namen) aus, in die die Läufer:innen importiert werden sollen +6. Klicke unten auf `Läufer importieren`, um die Läufer:innen zu importieren oder `Abbrechen`, um den Import abzubrechen +7. Die Läufer werden nun in die Organisation importiert + +## Import in ein Team +> Wähle diese Variante, wenn du Läufer direkt in ein Team importieren willst. + +Wenn in der Datei bei einer Läufer:in ein Team angegeben ist wird dieses ignoriert und mit dem gewählten Team überschrieben.. + +### Aus der Teamdetailansicht +1. Öffne im Läufersystem die Seite `Teams` +2. Klicke bei de, gewünschten Team auf den `Details` Button +3. Klicke oben auf `Läufer importieren` +4. Klicke auf `Datei auswählen` und wähle die Datei aus, aus der du Läufer:innen importieren willst +5. Dir wird eine Übersicht aller Läufer:innen angezeigt, die in der Datei gefunden wurden - überprüfe alle Läufer:innen auf Korrektheit +6. Wähle oben das Team aus, in die die Läufer:innen importiert werden sollen +7. Klicke unten auf `Läufer importieren`, um die Läufer:innen zu importieren oder `Abbrechen`, um den Import abzubrechen +8. Die Läufer werden nun in das Team importiert + +### Aus der Läuferübersicht +1. Öffne im Läufersystem die Seite `Läufer` +2. Klicke oben auf `Läufer importieren` +3. Klicke auf `Datei auswählen` und wähle die Datei aus, aus der du Läufer:innen importieren willst +4. Dir wird eine Übersicht aller Läufer:innen angezeigt, die in der Datei gefunden wurden - überprüfe alle Läufer:innen auf Korrektheit +5. Wähle oben das Team (Hat ein `>` im Namen) aus, in die die Läufer:innen importiert werden sollen +6. Klicke unten auf `Läufer importieren`, um die Läufer:innen zu importieren oder `Abbrechen`, um den Import abzubrechen 7. Die Läufer werden nun in das Team importiert \ No newline at end of file diff --git a/src/users/runners.md b/legacy/src/users/runners.md similarity index 98% rename from src/users/runners.md rename to legacy/src/users/runners.md index 29032a1..bda29d6 100644 --- a/src/users/runners.md +++ b/legacy/src/users/runners.md @@ -1,54 +1,54 @@ -# Läufer:innen - -Läufer sind das Herzstück des Läufersystems. -Über sie werden Strecken erfasst und Spenden berechnet. - -Läufer können einem Team oder einer Organisation zugeordnet werden. - -## Läuferübersicht -> Eine kurze Übersicht über die Funktionen der Läuferübersicht. - -In der Läuferübersicht werden alle im System registrierten Läufer:innen aufgelistet. -Von hier aus kannst du einzelne Läufer:innen hinzufügen, bearbeiten oder löschen. - -Um die Suche nach einzelnen Läufer:innen zu erleichtern gibt es einen Filter nach Teams und Organisationen. -Wenn du mehrere Teams/Organisationen in den Filter packst werden dir alle Läufer:innen angezeigt, die in einem/r der Teams/Organisationen registriert sind angezeigt. - -Ebenso gibt es eine Suchfunktion mit Hilfe derer du nach Läufernamen, -IDs und Gruppen (Teams/Organisationen) suchen kannst. -Du eine ID eingibst wird dir nur die Läufer:in mit genau der ID angezeigt, solltest du alle Läufer:innen sehen wollen, deren IDs mit deiner Eingabe beginnen stelle ein `*` ans Ende der ID. - -Beispiele: -* `Peter` -> Alle Läufer:innen mit Peter im Namen -* `Gymnasium` -> Alle Läufer:innen, die in einer Gruppe mit dem Namen Gymnasium sind -* `421` -> Die Läufer:in mit der ID 421 -* `42*` -> Alle Läufer:innen, deren ID mit 42 beginnt - -## Aktionen - -### Anlegen -> Achtung: Um eine Läufer:in anzulegen musst du vorher eine Organisation und/oder ein Team anlegen. - -Um eine neue Läufer:in anzulegen öffne im Läufersystem die Seite `Läufer`. -Über den Button `Läufer:in hinzufügen` kannst du eine neue Läufer:in anlegen. -Dabei musst du einen Vornamen, Nachnamen und die Gruppe (Team/Organisation) festlegen. -Zusätzlich kannst du einen Mittelnamen(2. Vornamen), eine Telefonnummer und eine E-Mail Adresse angeben. - -### Bearbeiten -Um eine Läufer:in zu bearbeiten kannst du in der Läuferübersicht den Button `Details` für die gewünschte Läufer:in anklicken. -In der Übersicht für die Läufer:in kannst du nun den Vornamen, Mittelnamen, Nachnamen, sowie die Telefonnummer, E-Mail Adresse und Gruppe bearbeiten. -Wenn du fertig bist klick einfach auf `Änderungen speichern`. - -### Löschen -> Du kannst eine Läufer:in entweder aus der Läuferübersicht oder der Läuferdetailansicht löschen. - -### In der Läuferübersicht -Klick bei der gewünschten Läufer:in auf den Button `Löschen`. -Daraufhin wirst du gefragt, ob du die Läufer:in wirklich löschen oder abbrechen willst. - -### In der Läuferdetailansicht -Klick bei der gewünschten Läufer:in auf den Button `Details`. -Oben auf der Seite gibt es jetzt den Knopf `Läufer:in löschen`. -Daraufhin wirst du gefragt, ob du die Läufer:in wirklich löschen oder abbrechen willst. - -## Import +# Läufer:innen + +Läufer sind das Herzstück des Läufersystems. +Über sie werden Strecken erfasst und Spenden berechnet. + +Läufer können einem Team oder einer Organisation zugeordnet werden. + +## Läuferübersicht +> Eine kurze Übersicht über die Funktionen der Läuferübersicht. + +In der Läuferübersicht werden alle im System registrierten Läufer:innen aufgelistet. +Von hier aus kannst du einzelne Läufer:innen hinzufügen, bearbeiten oder löschen. + +Um die Suche nach einzelnen Läufer:innen zu erleichtern gibt es einen Filter nach Teams und Organisationen. +Wenn du mehrere Teams/Organisationen in den Filter packst werden dir alle Läufer:innen angezeigt, die in einem/r der Teams/Organisationen registriert sind angezeigt. + +Ebenso gibt es eine Suchfunktion mit Hilfe derer du nach Läufernamen, -IDs und Gruppen (Teams/Organisationen) suchen kannst. +Du eine ID eingibst wird dir nur die Läufer:in mit genau der ID angezeigt, solltest du alle Läufer:innen sehen wollen, deren IDs mit deiner Eingabe beginnen stelle ein `*` ans Ende der ID. + +Beispiele: +* `Peter` -> Alle Läufer:innen mit Peter im Namen +* `Gymnasium` -> Alle Läufer:innen, die in einer Gruppe mit dem Namen Gymnasium sind +* `421` -> Die Läufer:in mit der ID 421 +* `42*` -> Alle Läufer:innen, deren ID mit 42 beginnt + +## Aktionen + +### Anlegen +> Achtung: Um eine Läufer:in anzulegen musst du vorher eine Organisation und/oder ein Team anlegen. + +Um eine neue Läufer:in anzulegen öffne im Läufersystem die Seite `Läufer`. +Über den Button `Läufer:in hinzufügen` kannst du eine neue Läufer:in anlegen. +Dabei musst du einen Vornamen, Nachnamen und die Gruppe (Team/Organisation) festlegen. +Zusätzlich kannst du einen Mittelnamen(2. Vornamen), eine Telefonnummer und eine E-Mail Adresse angeben. + +### Bearbeiten +Um eine Läufer:in zu bearbeiten kannst du in der Läuferübersicht den Button `Details` für die gewünschte Läufer:in anklicken. +In der Übersicht für die Läufer:in kannst du nun den Vornamen, Mittelnamen, Nachnamen, sowie die Telefonnummer, E-Mail Adresse und Gruppe bearbeiten. +Wenn du fertig bist klick einfach auf `Änderungen speichern`. + +### Löschen +> Du kannst eine Läufer:in entweder aus der Läuferübersicht oder der Läuferdetailansicht löschen. + +### In der Läuferübersicht +Klick bei der gewünschten Läufer:in auf den Button `Löschen`. +Daraufhin wirst du gefragt, ob du die Läufer:in wirklich löschen oder abbrechen willst. + +### In der Läuferdetailansicht +Klick bei der gewünschten Läufer:in auf den Button `Details`. +Oben auf der Seite gibt es jetzt den Knopf `Läufer:in löschen`. +Daraufhin wirst du gefragt, ob du die Läufer:in wirklich löschen oder abbrechen willst. + +## Import > Die Importanleitung findest du hier \ No newline at end of file diff --git a/src/users/scans.md b/legacy/src/users/scans.md similarity index 100% rename from src/users/scans.md rename to legacy/src/users/scans.md diff --git a/src/users/scanstations.md b/legacy/src/users/scanstations.md similarity index 100% rename from src/users/scanstations.md rename to legacy/src/users/scanstations.md diff --git a/src/users/sponsoring_contracts.md b/legacy/src/users/sponsoring_contracts.md similarity index 100% rename from src/users/sponsoring_contracts.md rename to legacy/src/users/sponsoring_contracts.md diff --git a/src/users/teams.md b/legacy/src/users/teams.md similarity index 98% rename from src/users/teams.md rename to legacy/src/users/teams.md index 8d63609..020f804 100644 --- a/src/users/teams.md +++ b/legacy/src/users/teams.md @@ -1,35 +1,35 @@ -# Teams - -Läuferteams sind die Untergruppen des Gruppensystems für Läufer:innen. -Ein Team kann eine Klasse, Abteilung, Gruppe oder ähnliches sein. - -Läufer:innen können einem Team zugeordnet werden, das wiederum zu einer Organisation gehört (mehr zu Organisationen findest du hier). -Einer/m Organisation/Team kann ein Kontakt zugeordnet werden, mehr dazu findest du hier. - -## Anlegen -> Achtung: Um ein Team anzulegen musst du vorher die Mutter-Organisation für das Team anlegen. - -Um ein neues Team anzulegen öffne im Läufersystem die Seite `Teams`. -Über den Button `Team erstellen` kannst du ein neues Team erstellen. -Dabei kannst du dem Team einen Namen geben und auswählen, zu welcher Organisation das Team gehört. - -## Bearbeiten -Um ein Team zu bearbeiten kannst du in der Teamübersicht den Button `Details` für das gewünschte Team anklicken. -In der Übersicht für dieses Team kannst du nun den Namen, die Mutter-Organisation und den Kontakt des Teams ändern. -Wenn du fertig bist klick einfach auf `Änderungen speichern`. - -## Löschen -> Du kannst ein Team entweder aus der Teamübersicht oder der Teamdetailansicht löschen. - -### In der Teamübersicht -Klick bei dem gewünschten Team auf den Button `Löschen`. -Daraufhin wirst du gefragt, ob du das Team wirklich löschen oder abbrechen willst. - -### In der Teamdetailansicht -Klick bei dem gewünschten Team auf den Button `Details`. -Oben auf der Seite gibt es jetzt den Knopf `Team löschen`. -Daraufhin wirst du gefragt, ob du das Team wirklich löschen oder abbrechen willst. - -### Teams mit Läufern -Sollte das Team noch Läufer haben geht nach dem Bestätigen der Löschung nochmal eine Warnung auf. +# Teams + +Läuferteams sind die Untergruppen des Gruppensystems für Läufer:innen. +Ein Team kann eine Klasse, Abteilung, Gruppe oder ähnliches sein. + +Läufer:innen können einem Team zugeordnet werden, das wiederum zu einer Organisation gehört (mehr zu Organisationen findest du hier). +Einer/m Organisation/Team kann ein Kontakt zugeordnet werden, mehr dazu findest du hier. + +## Anlegen +> Achtung: Um ein Team anzulegen musst du vorher die Mutter-Organisation für das Team anlegen. + +Um ein neues Team anzulegen öffne im Läufersystem die Seite `Teams`. +Über den Button `Team erstellen` kannst du ein neues Team erstellen. +Dabei kannst du dem Team einen Namen geben und auswählen, zu welcher Organisation das Team gehört. + +## Bearbeiten +Um ein Team zu bearbeiten kannst du in der Teamübersicht den Button `Details` für das gewünschte Team anklicken. +In der Übersicht für dieses Team kannst du nun den Namen, die Mutter-Organisation und den Kontakt des Teams ändern. +Wenn du fertig bist klick einfach auf `Änderungen speichern`. + +## Löschen +> Du kannst ein Team entweder aus der Teamübersicht oder der Teamdetailansicht löschen. + +### In der Teamübersicht +Klick bei dem gewünschten Team auf den Button `Löschen`. +Daraufhin wirst du gefragt, ob du das Team wirklich löschen oder abbrechen willst. + +### In der Teamdetailansicht +Klick bei dem gewünschten Team auf den Button `Details`. +Oben auf der Seite gibt es jetzt den Knopf `Team löschen`. +Daraufhin wirst du gefragt, ob du das Team wirklich löschen oder abbrechen willst. + +### Teams mit Läufern +Sollte das Team noch Läufer haben geht nach dem Bestätigen der Löschung nochmal eine Warnung auf. Hier musst du nochmal die Löschung inklusive aller Läufer bestätigen, alternativ kannst du auch Abbrechen. \ No newline at end of file diff --git a/src/users/tracks.md b/legacy/src/users/tracks.md similarity index 100% rename from src/users/tracks.md rename to legacy/src/users/tracks.md