Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Dokumentation der Struktur #7

Open
mnagel opened this Issue · 4 comments

4 participants

@mnagel

Die Struktur des Repos sollte besser dokumentiert werden.
Augenscheinlich gibt es für jeden Buchstaben einen Ordner (um die Anzahl der jeweiligen Unterordner klein zu halten(?)) und darin pro Gesetz einen Ordner benannt nach dem Kurznamen des Gesetzes (?) und darin eine index.md.
Ist das so korrekt? Was sind die Gründe für diese Struktur?

Was ist das eigentliche Endprodukt / wie ist die Nutzung des Repos gedacht / welche Use-Cases gibt es?
Klickt man sich auf https://github.com/bundestag/gesetze durch?
Öffnet man das Repo lokal in gitk/gitx/tortoise?
Sollte es einen STRG-F-durchsuchbaren Index mit den ausgeschriebenen Namen geben? Wie wird dieser generiert?

@mnagel

bei Twitter gefunden: http://bundestag.github.com/gesetze/
das sollte z.B. auch in der Readme erwähnt werden...

@stefanw
Owner

Die Anfangsbuchstabe-Unterordner-Struktur ist tatsächlich damit man nicht 6000+ Ordner in einem hat.

Die Gesetzdatei heißt index.md, weil:

  • GitHub Pages branch auf dem master repo aufbaut und ein index.md von Jekyll in index.html umgebaut wird
  • Der Name des Gesetzes schon im Ordnernamen steht
  • Das eine schön einfache Konvention ist. Ein Ordner enthält bei manchen Gesetzen auch Bilder, PDFs etc.

Wie man dieses Repo nutzt ist noch nicht ganz klar. Es gibt aber fantastische Möglichkeiten.

Die gerenderten Gesetze aus dem gh-pages Branch sind noch sehr grob, ohne CSS, deswegen wurden sie noch nicht in der README erwähnt.

Es ist angedacht die gerenderten Gesetze per JavaScript mit der GitHub API zu verbinden und Pull Request-Änderungen oder Issues direkt am gerenderten Gesetz anzuzeigen.

@surma

@mnagel Nach Dateinamen lässt sich schon über die Github-Oberfläche suchen, wenn man [t] drückt.

@rriemann

We should consider to build the html representation on top of middlemanapp or octopress (octopress is a more feature-rich template/plugin set for jekyll).
http://middlemanapp.com/
http://octopress.org/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.