Skip to content
Snippets Groups Projects
Commit 8ffa281d authored by Max Melchert's avatar Max Melchert
Browse files

docs(makefile): add todos

parent 0e3bb972
Branches
No related tags found
No related merge requests found
...@@ -170,7 +170,8 @@ Der Aufruf von `make download` speichert diese Dateien im zuvor definierten Ordn ...@@ -170,7 +170,8 @@ Der Aufruf von `make download` speichert diese Dateien im zuvor definierten Ordn
## Konfiguration ## Konfiguration
> [!important] > [!important]
> Die Anpassung der in der _Makefile_ mit `# todo` gekennzeichneten Konfigurationsvariablen ist zwingend erforderlich, um eine korrekte Ausführung sicherzustellen. > Die Anpassung der in der _Makefile_ mit `#TODO` gekennzeichneten Konfigurationsvariablen ist zwingend erforderlich, um eine korrekte Ausführung sicherzustellen.
> Die `#TODO`-Tags müssen außerdem unbedingt entfernt werden, bevor die _Makefile_ verwendet werden kann; mögliche Leerzeichen führen sonst zu Problemen.
### Server ### Server
...@@ -286,7 +287,7 @@ Also bspw. `~/akis/my_project` oder `/home/mmustermann/akis/my_project`. ...@@ -286,7 +287,7 @@ Also bspw. `~/akis/my_project` oder `/home/mmustermann/akis/my_project`.
#### `MAIN_SCRIPT` #### `MAIN_SCRIPT`
> ... definiert das _Python_-Script, welches die _Makefile_ auf dem Server ausführt.s > ... definiert das _Python_-Script, welches die _Makefile_ auf dem Server ausführt.
In Projekten mit nur einem Python-Script beinhaltet dieses Script den gesamten Code. In Projekten mit nur einem Python-Script beinhaltet dieses Script den gesamten Code.
In Projekten mit mehreren Python-Scripts führt das `MAIN_SCRIPT` meist weitere Python-Scripts aus. In Projekten mit mehreren Python-Scripts führt das `MAIN_SCRIPT` meist weitere Python-Scripts aus.
...@@ -391,15 +392,31 @@ Für diesen Fall ist `COPY_LINKS_AS_FILES` auf `true` zu setzen. ...@@ -391,15 +392,31 @@ Für diesen Fall ist `COPY_LINKS_AS_FILES` auf `true` zu setzen.
## TODOs ## TODOs
- [x] Bedienung über _Byobu_ ### Documentation
- [ ] Datasets über NFS
- [ ] Benachrichtigung bei Abbruch/Erfolg - [x] docs(makefile): add byobu installation
- [ ] docs(makefile): add byobu shortcuts
- [ ] docs(makefile): get local python packages; append to `PYTHON_PACKAGES`
### Fixes
- [ ] fix(makefile): `source` Mamba
- [x] fix(makefile): support download file wildcards
- `REMOTE_DOWNLOAD_FILES := *.pdf *.png`
- [ ] feat(makefile): pypi package support
### Features
- [ ] feat(makefile): add status notification
- [ ] Slack - [ ] Slack
- [ ] E-Mail - [ ] E-Mail
- [ ] Matrix - [ ] Matrix
- [ ] parallele Ausführung mehrerer Scripts - [ ] feat(makefile): parallele execution of scripts; multiple servers
- [ ] docs: get local python packages; append to `PYTHON_PACKAGES` - [ ] feat(makefile): sync local env with server and update
- [ ] `source` Mamba
### Other
- [ ] ops: add datasets via NFS
--- ---
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment