Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Action Umgestaltung (Anki und PDF Releases) #118

Open
RvNovae opened this issue Nov 24, 2021 · 10 comments
Open

Action Umgestaltung (Anki und PDF Releases) #118

RvNovae opened this issue Nov 24, 2021 · 10 comments
Assignees
Labels
enhancement New feature or request help wanted Extra attention is needed question Further information is requested

Comments

@RvNovae
Copy link
Member

RvNovae commented Nov 24, 2021

Wie man mittlerweile schon öfters gesehen hat, ist dieses ganze rumgeregexe in den actions zwar witzig aber nicht sonderlich praktisch.
Ich schlage daher vor, dass wir den Prozess mal umgestalten, für Ideen bin ich offen.

Meine Idee wäre es, eine Datei zu haben, in der alle zu-wandelnden Dokumente in einer Liste eingetragen sind.
Die Action ließt dann die Datei zeilenweise und wandelt die entsprechenden Dateien.
Das wäre deutlich flexibler und weniger fehleranfällig, als die aktuelle Lösung.

Man könnte dann beispielsweise eine Datei für PDFs und eine für Anki-Decks haben.
Dadurch ist dann schnell ersichtlich was gerendert wird, und Sachen lassen sind schnell hinzufügen oder rausnehmen.

Lasst mal eure Meinungen dazu hören 😄

@RvNovae RvNovae added the enhancement New feature or request label Nov 24, 2021
@RvNovae RvNovae self-assigned this Nov 24, 2021
@RvNovae RvNovae added help wanted Extra attention is needed question Further information is requested labels Nov 24, 2021
@sthinbetween
Copy link
Member

Nichts dagegen :) werde dank HO ab nächster Woche vielleicht sogar Zeit finden um dazu was beizutragen :D

@sthinbetween
Copy link
Member

sthinbetween commented Nov 24, 2021

Idee für Struktur der jeweiligen Dateien wäre Pfad der Ausgangsdatei und Exportpfad jeweils auf eine Zeile, dazwischen ein Delimiter und dann halt EOL.

Lässt sich sowohl menschen- als auch maschinenlesbar ganz schön gestalten und erlaubt gute Änderungen.
Workflow sollte sich gut anpassen lassen.

@sthinbetween sthinbetween self-assigned this Nov 24, 2021
@ZeroPointMax
Copy link
Member

ZeroPointMax commented Nov 25, 2021

Beide Seiten haben Vor- und Nachteile. Ein Vorteil von rumregexen ist, dass man den Workflow gar nicht anpassen muss, um Artefakte zu generieren, sondern lediglich eine Datei richtig benennen muss. Das hat Yannis glaube ich entwickelt, weil wir davor tatsächlich Dateilisten hatten, allerdings inmitten eines Bash Scriptes und man auch noch an zwei Stellen anpassen musste, damit sich da was tut.

Ich finde den jetzigen "it just works [or it just doesn't]"-Ansatz persönlich zwar besser, sehe aber auch, dass sich die Anforderungen an den Workflow geändert haben.

@ZeroPointMax
Copy link
Member

Was mich am meisten verwundert: warum brauchen wir zwei Anki-Decks für ein Modul? Wir haben Glossar.md und LKF.md, die direkt miteinander konkurrieren. Hatten wir so auch noch nie :D

@sthinbetween
Copy link
Member

Kann wie Max auch beides verstehen. Ebenso möglich wäre es, die Naming-Conventions und -Pfade irgendwo sinnvoll zu dokumentieren. Dann müsste auch das REGEX nicht angepasst werden, wenn gut dokumentiert ist, was wann wo und warum passiert.

@sthinbetween
Copy link
Member

Was mich am meisten verwundert: warum brauchen wir zwei Anki-Decks für ein Modul? Wir haben Glossar.md und LKF.md, die direkt miteinander konkurrieren. Hatten wir so auch noch nie :D

das ist nun mal historisch gewachsen 🗡️

@RvNovae
Copy link
Member Author

RvNovae commented Nov 25, 2021

Kann wie Max auch beides verstehen. Ebenso möglich wäre es, die Naming-Conventions und -Pfade irgendwo sinnvoll zu dokumentieren. Dann müsste auch das REGEX nicht angepasst werden, wenn gut dokumentiert ist, was wann wo und warum passiert.

Dem schließe ich mich an, in beiden Fällen würde eine gescheite Dokumentation bereits helfen.

@ZeroPointMax
Copy link
Member

Ping

@sthinbetween
Copy link
Member

Gestern auch wieder dran gedacht. Bin gerade leider noch am projektarbeiten, würde mich aber direkt nach Abgabe dransetzen ;)

@photovoltex
Copy link
Member

photovoltex commented Feb 10, 2022

[Vorschlag]:
Spricht eigentlich irgendwas gegen eine einfache Naming Convention im Sinne der Endung wie z.B.
<insert any name>.anki.md
<insert any name>.pdf.md
Dann schaut man, wie aktuell, mit regex alle Ordner (müssen z.B. auch nicht mehr beschränkt benannt werden) nach der Endung und entsprechende Dateien werden verarbeitet.
Wäre zumindest wenig Dokumentation notwendig und die Namen sind sprechend.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed question Further information is requested
Projects
None yet
Development

No branches or pull requests

4 participants