Klare Ordnerstruktur für Module definieren

Question

Klare Ordnerstruktur für Module definieren

Steve2955 opened this issue 4 years ago · 23 comments

Ich würde gerne eine einheitliche Struktur für Module definieren. Was sich momentan als Standard etabliert hat sieht wie folgt aus:

Modul/
├── resources/ - Bilder
│   ├── imgA.png
│   ├── imgB.png
│   └── imgB.svg
└── README.md - Modulmitschriften

Wie wollen wir darin folgende Dokumente unterbringen:

Cheatsheets
Programmier-Übungen (z.B. wie in NET)
Praktika (wie in DBS)
Vorträge (z.B. in RES)
... (ich habe bestimmt noch was vergessen)

Eventuell könnten wir dann auch ein paar Automatismen entwickeln, die für die PDFs die zusätzliche Files in einen Anhang packen.

Was mir noch aufgefallen ist, ist das in diesem Repo noch aus Zeiten indem es nur privat zugänglich war, noch das Skript von DBS liegt. Ich denke wir sollten das entfernen.

Answer 1 · 2020-12-03T13:50:56.000Z

Eine weitere wichtige Frage wäre, ob wir zukünftige Semester auch in diesem Repository verwalten wollen oder ob wir dafür getrennte Repos erstellen?

Answer 2 · 2020-12-03T13:55:49.000Z

Eine weitere wichtige Frage wäre, ob wir zukünftige Semester auch in diesem Repository verwalten wollen oder ob wir dafür getrennte Repos erstellen?

Der Übersicht halber (und weil der Name des Repos es ja suggeriert) wäre es wahrscheinlich die zu trennen.
Blöd ist nur, dass man dann die ganzen Actions übernehmen müsste. Man könnte aber vielleicht ein Template-Repo basteln, auf dem man dann jedes neues Semester basieren kann. Nur so als Idee 😄

Answer 3 · 2020-12-03T14:50:51.000Z

Den Namen dieses Repos könnten wir auch ohne Probleme ändern. @ZeroPointMax Welche Option würdest du bevorzugen?

alle Semester in eine Repo zusammenfassen
jedes Semester in eigenem Repo
jedes Semester in eigenem Repo und als Submodules nochmal in eine Repo zusammenfassen
weitere Vorschläge?

Answer 4 · 2020-12-04T07:02:06.000Z

Was würden wir eigentlich mit Modulen machen, die über mehrere Semester gehen oder Module wie INV, die diese komische Zweiteilung haben 😅

Answer 5 · 2020-12-04T07:35:06.000Z

@ZeroPointMax @RvNovae Hier mal ein Vorschlag als Diskussionsgrundlage:

<Semester>/
├── <Modul>/
│   ├── additional/         <- Anhang: Praktika, Übungen, ...
│   │   ├── <Praktika>.md
│   │   ├── <Cheatsheet>.md
│   │   └── <Übung>.md
│   ├── extra/              <- Zusätzliches: Vorträge, ...
│   │   └── <Vortag>.pdf
│   ├── figures/            <- Bilder (können auch bei resources bleiben)
│   │   ├── <filename>.png
│   │   ├── <filename>.png
│   │   └── <filename>.svg
│   └── README.md           <- Modulmitschriften
└── README.md 

<Semester> ::= SEMESTER-{1|2|3|4|5|6}

<Modul> ::= <Kürzel>-<Dozent>
<Kürzel> ::= {RES|ALGO|INV|DBS|NET|...}
<Dozent> ::= {DORENDORF|KUSCHE|KASCHE|GUENTHER|FELDMANN|...}

<filename> :: <zeichen><filename> | <zeichen>
<zeichen> ::= a..z | 0..9 | -
^^kebab-case

Alle Semester in einem Repo (dieses Repo entsprechen umbenennen)
Module über mehrere Semester werden dem Semester zugeordnet in dem sie beginnen
Aufspaltung von zweigeteilten Modulen (z.B. INV -> INV + DT)
alles in additional/ wird für die PDFs an die Modulmitschriften angehangen
extra/ enthält nur zusätliche Sachen, die in den PDFs keine Erwähnung finden

Answer 6 · 2020-12-04T09:35:54.000Z

Den Namen dieses Repos könnten wir auch ohne Probleme ändern. @ZeroPointMax Welche Option würdest du bevorzugen?

alle Semester in eine Repo zusammenfassen

jedes Semester in eigenem Repo

jedes Semester in eigenem Repo und als Submodules nochmal in eine Repo zusammenfassen

weitere Vorschläge?

Ich wäre für 2, ggf. mit Template

Answer 7 · 2020-12-04T09:54:02.000Z

@Steve2955 @RvNovae

bzgl. Diskussionsgrundlage: (ich komme zum Punkt, schönes Reden ist in einer Kasche-VL zu anstrengend ;) )

ich mag keine Monolithen, daher wäre ich für separate Repos pro Semester ;)
woher kam eigentlich resources? --> ich glaub, das hab ich mal aus der Firma mitgebracht: alles, was in die README verlinkt wird, in diesen Ordner yeeten. Schnell, einfach, unübersichtlich.
daher würde ich begrüßen, das neu zu machen.
die Aufteilung in extraund additional finde ich von der Intention gut, aber die Namen würde ich anders wählen, damit man sie besser unterscheiden kann. Bzw. @Steve2955 kannst du die Aufteilung bitte nochmal verbosiger beschreiben, was deine Gedanken dahinter sind?
Frage: wenn wir resources in figures umbenennen und wir haben Gott-weiß-welche Sachen, die wir verlinken wollen, wo kommen die dann hin?

Answer 8 · 2020-12-04T10:07:26.000Z

wenn wir resources in figures umbenennen und wir haben Gott-weiß-welche Sachen, die wir verlinken wollen, wo kommen die dann hin?

Was genau meinst du damit? Bisher sind in den resources-Verzeichnissen nur Bilder. Mich würde es jetzt nicht stören wenn da 100+ oder mehr Bilder drin sind solange diese ordentlich benannt sind.

Answer 9 · 2020-12-04T10:14:56.000Z

wenn wir resources in figures umbenennen und wir haben Gott-weiß-welche Sachen, die wir verlinken wollen, wo kommen die dann hin?

Was genau meinst du damit? Bisher sind in den resources-Verzeichnissen nur Bilder. Mich würde es jetzt nicht stören wenn da 100+ oder mehr Bilder drin sind solange diese ordentlich benannt sind.

Für den Fall, das mal was anderes als Bilder reinkommt meine ich. Wüsste jetzt aber auch nicht, was das wäre

Answer 10 · 2020-12-04T10:25:52.000Z

Nennen wir es doch einfach assets oder so 😉

Answer 11 · 2020-12-04T10:26:00.000Z

die Aufteilung in extraund additional finde ich von der Intention gut, aber die Namen würde ich anders wählen, damit man sie besser unterscheiden kann. Bzw. @Steve2955 kannst du die Aufteilung bitte nochmal verbosiger beschreiben, was deine Gedanken dahinter sind?

@ZeroPointMax extra und additional können wir gerne umbenennen, da bin ich für Vorschläge offen.

Die Idee hinter additional ist alles zusammenzufassen, was keine Vorlesungsmitschrift ist, aber eigentlich mit dazu gehört. Also z.B. die Praxisübungen, die wir in NET machen oder das Praktikum zu DBS.

extra soll Sachen zusammenfassen die zusätzlich zu den Vorlesungsmitschriften und additional existieren, wie z.B. die Vorträge in RES. Die Vorbereitung der Vorträge kann da gerne auch noch mit rein. Solche Sachen werden in der Regel in den Mitschriften/additional kurz zusammengesfasst (wie im Fall von RES) oder habe an sich keine Bedeutung für Klausuren und sind rein zusätzliche optionale Infos.

So hätte ich mir das in etwa vorgestellt 🤔

Answer 12 · 2020-12-04T10:27:48.000Z

ich mag keine Monolithen, daher wäre ich für separate Repos pro Semester ;)

Module über mehrere Semester sind dann im Semester in dem sie beginnen oder aufgeteilt?

Answer 13 · 2020-12-04T10:31:10.000Z

ich mag keine Monolithen, daher wäre ich für separate Repos pro Semester ;)

Module über mehrere Semester sind dann im Semester in dem sie beginnen oder aufgeteilt?

aufgeteilt

Answer 14 · 2020-12-04T10:32:48.000Z

die Aufteilung in extraund additional finde ich von der Intention gut, aber die Namen würde ich anders wählen, damit man sie besser unterscheiden kann. Bzw. @Steve2955 kannst du die Aufteilung bitte nochmal verbosiger beschreiben, was deine Gedanken dahinter sind?

@ZeroPointMax extra und additional können wir gerne umbenennen, da bin ich für Vorschläge offen.

Die Idee hinter additional ist alles zusammenzufassen, was keine Vorlesungsmitschrift ist, aber eigentlich mit dazu gehört. Also z.B. die Praxisübungen, die wir in NET machen oder das Praktikum zu DBS.

extra soll Sachen zusammenfassen die zusätzlich zu den Vorlesungsmitschriften und additional existieren, wie z.B. die Vorträge in RES. Die Vorbereitung der Vorträge kann da gerne auch noch mit rein. Solche Sachen werden in der Regel in den Mitschriften/additional kurz zusammengesfasst (wie im Fall von RES) oder habe an sich keine Bedeutung für Klausuren und sind rein zusätzliche optionale Infos.

So hätte ich mir das in etwa vorgestellt 🤔

Ahja, da wäre ich voll dafür. Ich sehe lediglich das Problem, dass ich mir nicht merken kann, was in additional und was in extra gehört, weil das fast-Synonyme in meinem Gehirn sind

Answer 15 · 2020-12-06T19:09:30.000Z

die Aufteilung in extraund additional finde ich von der Intention gut, aber die Namen würde ich anders wählen, damit man sie besser unterscheiden kann. Bzw. @Steve2955 kannst du die Aufteilung bitte nochmal verbosiger beschreiben, was deine Gedanken dahinter sind?

@ZeroPointMax extra und additional können wir gerne umbenennen, da bin ich für Vorschläge offen.
Die Idee hinter additional ist alles zusammenzufassen, was keine Vorlesungsmitschrift ist, aber eigentlich mit dazu gehört. Also z.B. die Praxisübungen, die wir in NET machen oder das Praktikum zu DBS.
extra soll Sachen zusammenfassen die zusätzlich zu den Vorlesungsmitschriften und additional existieren, wie z.B. die Vorträge in RES. Die Vorbereitung der Vorträge kann da gerne auch noch mit rein. Solche Sachen werden in der Regel in den Mitschriften/additional kurz zusammengesfasst (wie im Fall von RES) oder habe an sich keine Bedeutung für Klausuren und sind rein zusätzliche optionale Infos.
So hätte ich mir das in etwa vorgestellt 🤔

Ahja, da wäre ich voll dafür. Ich sehe lediglich das Problem, dass ich mir nicht merken kann, was in additional und was in extra gehört, weil das fast-Synonyme in meinem Gehirn sind

Vielleicht assets und extra / additional?
Das sollte etwas weniger verwirrend sein, da assets ja kein Wort ist, das was zusätzliches ausdrückt

Answer 16 · 2020-12-09T17:51:39.000Z

@RvNovae aber andererseits wollten wir das ja als Ersatz für resources nehmen

Answer 17 · 2020-12-09T17:56:18.000Z

@RvNovae aber andererseits wollten wir das ja als Ersatz für resources nehmen

Passt da assets nicht wunderbar? 🤔

Answer 18 · 2020-12-09T17:59:51.000Z

@RvNovae aber andererseits wollten wir das ja als Ersatz für resources nehmen

Passt da assets nicht wunderbar? 🤔

Ja genau, uns geht es eigentlich darum, dass sich extra und additional semantisch nicht stark genug abgrenzen.

Answer 19 · 2020-12-09T19:42:19.000Z

@RvNovae aber andererseits wollten wir das ja als Ersatz für resources nehmen

Passt da assets nicht wunderbar? 🤔

Ja genau, uns geht es eigentlich darum, dass sich extra und additional semantisch nicht stark genug abgrenzen.

Deswegen schlage ich ja assets vor?
Ich glaube wir reden aneinander vorbei 😅

Answer 20 · 2020-12-09T19:49:34.000Z

@RvNovae aber andererseits wollten wir das ja als Ersatz für resources nehmen

Passt da assets nicht wunderbar? 🤔

Ja genau, uns geht es eigentlich darum, dass sich extra und additional semantisch nicht stark genug abgrenzen.

Deswegen schlage ich ja assets vor?
Ich glaube wir reden aneinander vorbei 😅

Wir dachten assets statt figures 😂

Answer 21 · 2020-12-09T19:52:49.000Z

@RvNovae aber andererseits wollten wir das ja als Ersatz für resources nehmen

Passt da assets nicht wunderbar? 🤔

Ja genau, uns geht es eigentlich darum, dass sich extra und additional semantisch nicht stark genug abgrenzen.

Deswegen schlage ich ja assets vor?
Ich glaube wir reden aneinander vorbei 😅

Wir dachten assets statt figures 😂

Ahhhhh, ich glaub ich hab einfach nicht genau gelesen.
Passt, das war einfach nur allgemeine Verwirrung auf meiner Seite 😂

Answer 22 · 2021-01-04T06:44:43.000Z

@RvNovae @ZeroPointMax Was ich noch vorschlagen würde ist statt additional einfach appendix zu verwenden:

<Modul>/
├── appendix/           <- Anhang: Praktika, Übungen, ...
│   ├── <Praktika>.md
│   ├── <Cheatsheet>.md
│   └── <Übung>.md
├── extra/              <- Zusätzliches: Vorträge, ...
│   └── <Vortag>.pdf
├── assets/             <- Bilder
│   ├── <filename>.png
│   ├── <filename>.png
│   └── <filename>.svg
└── README.md           <- Modulmitschriften

<Modul> ::= <Kürzel>-<Dozent>
<Kürzel> ::= {RES|ALGO|INV|DBS|NET|...}
<Dozent> ::= {DORENDORF|KUSCHE|KASCHE|GUENTHER|FELDMANN|...}

<filename> :: <zeichen><filename> | <zeichen>
<zeichen> ::= a..z | 0..9 | -
^^kebab-case

Alle Semester in eigenem Repo (pro forma alle zusätzlich per Submodule in einem Repo zusammenfassen)
Module über mehrere Semester werden auf diese entsprechend aufgeteilt
Falls weitere Matrikel an diesem Repository mitarbeiten wollen, sollten wir die Module direkt den entsprechenden Dozenten zuordnen
Aufspaltung von zweigeteilten Modulen (z.B. INV -> INV + DT)
alles in appendix/ wird für die PDFs an die Modulmitschriften angehangen
extra/ enthält nur zusätliche Sachen, die in den PDFs keine Erwähnung finden

Answer 23 · 2021-01-13T08:53:24.000Z

Klingt gut!