Kristian Schultz před 4 roky
rodič
revize
7f3e4d1c7e
2 změnil soubory, kde provedl 125 přidání a 16 odebrání
  1. 40 13
      src/faq/doNotStore.tex
  2. 85 3
      src/faq/whatisgit.tex

+ 40 - 13
src/faq/doNotStore.tex

@@ -1,13 +1,41 @@
 %\section{\de{Gespeicherte Daten verwalten}\en{Manage stored data}}
+
+
+
+
+
+
+
+
+
+% -------------------------------------------------------------------
+% Do not Store in GIT
+% -------------------------------------------------------------------
+
+
 |DE>\subsection{Was \underline{nicht} in GIT gespeichert werden sollte}
 |EN>\subsection{What \underline{not} to store in in GIT}
 
+% -------------------------------------------------------------------
+|DE>Bei Binärdateien (z.B. Bilder, Videos, ZIP-Dateien, PDF-Dateien, JAR-Pakete) sind die Daten nicht in Textzeilen angeordnet.
+|DE>Deswegen müssen bei Änderungen jeweils die gesamte Datei in der History gespeichert werden.
+|DE>Selbst, wenn sich nur ein Pixel geändert hat!
+|DE>Das führt dazu, dass Binärdateien die Größe eines GIT-Repositories schnell anwachsen lassen können.
+% -------------------------------------------------------------------
+|EN>As it comes to binary files (like images, videos, ZIP files, PDF files, JAR packets) things get complicated.
+|EN>This files are not stored in text lines.
+|EN>So GIT has to store the whole file on every change.
+|EN>Even if you simply change one pixel in a big image.
+|EN>For that reason binary files can grow your GIT history quickly.
+% -------------------------------------------------------------------
+
+
 % TODO: Asked for 10MB
-|DE>    Die folgenden Daten sollten nicht in GIT gespeichert werden.
-|DE>    Insbesondere wenn die Datei > 5 MB ist.
+|DE>    Die folgenden Daten sollten deswegen möglichst nicht in GIT gespeichert werden.
+|DE>    Insbesondere wenn die Datei >~5~MB ist.
 |DE>    (Ausnahme: Die Datei ist für die Erstellung Ihres Projektes erforderlich und lässt sich nicht automatisch generieren.)
 |EN>    The following files should not stored in GIT.
-|EN>    Especially if the file size is > 5 MB.
+|EN>    Especially if the file size is >~5~MB.
 |EN>    (Exception: This file is needed to create your output files and there is no other way to create this file.)
 
 \newcommand{\ext}[1]{\var{*.#1}}
@@ -58,7 +86,9 @@
 \end{itemize}
 
 |DE> Repositorys sollten mit History < 300 MB bleiben.
+|DE> Wenn Sie sich nicht sicher sind, ob Ihre Datei in das GIT-Repository geh\"ort, fragen Sie Ihren Betreuer.
 |EN> Your repository should stay < 300 MB, including history.
+|EN> If you are unsure whether your file belongs in the GIT repository, ask your supervisor.
 %\\
 %Bei Repositories $\geq$ 500MB mahnen wir.
 
@@ -68,22 +98,19 @@
 
 
 
-\subsection{\de{Was in ein GIT-Repository gehört.}\en{What to store in a GIT repository}}
-\begin{itemize}
-\item \de{Quelltexte}\en{Source code}
-\item \de{Dokumentationen}\en{Documentation}
-\item Makefiles
-\item \de{Zum Bauen erforderliche Konfigurationen.}\en{Configuration needed to build your project.}  
-\item
-|DE>  Notwendige Dateien, die nicht generiert oder aus dem Internet / anderen Repositories geladen werden können.
-|EN>  Needed files that can't be generated or loaded from the internet or other repositories.
-\end{itemize}
 
 
 
 
 
 
+
+% -------------------------------------------------------------------
+% Examples
+% -------------------------------------------------------------------
+
+
+
 \newpage
 \subsection{\de{Von GIT verwaltete Dateien konfigurieren}\en{Configure files managed by GIT}}
 

+ 85 - 3
src/faq/whatisgit.tex

@@ -1,4 +1,86 @@
-\section{\de{Wozu GIT?}\en{Why GIT?}}
-|DE>GIT ist ... 123
-|EN>GIT is ... 567
+\section{GIT?}
+|DE>\subsection{Was was GIT?}
+|EN>\subsection{What is GIT?}
+% -------------------------------------------------------------------
+|DE>GIT ist ein dezentrales Versionsverwaltungssystem für die arbeit von einer oder mehrerer Personen an einem Quelltext.
+|DE>In GIT werden die Veränderungen von Dateien in einer History gespeichert.
+|DE>Korrekt angewendet, können Änerungen an Textdateien zeilenweise nachvollzogen und einem konkretem Nutzer zugeschrieben werden.
+|DE>Falls notwendig, können so ältere Versionen einzelner Dateien wieder hergestellt werden.
+|DE>Da GIT nur die geänderten Zeilen in der History abspeichert, kann es effizient und platzsparend auch eine längere History verwalten.
+|DE>Es lohnt sich also nach jeder noch kleinen Änderung ein Commit zu erstellen, um bei auftretenden Problemen die Änderungen wieder Schrittweise zurück gehen zu können und somit die Problematische Stelle zu finden.
+% -------------------------------------------------------------------
+|EN>GIT is a decentral Version Control System for the collaborative work of one or more persons.
+|EN>It stores changes of your files in a history.
+|EN>If you use it correctly, you may trace changes to text files line by line and assign the change to a specific user.
+|EN>If needed, you may restore an older version of your file.
+|EN>GIT stores only the changed lines.
+|EN>Therefore it needs a small amount of memory to store a long history of many files.
+|EN>Commit your changes as small and often as possible.
+|EN>So you will be able to pinpoint a changing, that messes with your code by boing step by step back in the history of changes.
+% -------------------------------------------------------------------
+
+
+
+% -------------------------------------------------------------------
+% Good to store in GIT
+% -------------------------------------------------------------------
+
+|DE>In ein GIT Repository gehören:
+|EN>You should put in a GIT repository:
+\begin{itemize}
+\item
+|DE> Quelltexte
+|EN> Source code
+\item Makefiles
+\item
+|DE> Zum Bauen erforderliche Konfigurationen.
+|EN> Configuration needed to build your project.
+\item
+|DE>  Notwendige Dateien, die nicht generiert oder aus dem Internet / anderen Repositories geladen werden können.
+|EN>  Needed files that can't be generated or loaded from the internet or other repositories.
+\item
+|DE> Dokumentationen mit benötigten Grafiken.
+|EN> Documentation with needed graphics.
+\item
+|DE> Protokolle, die ein nicht automatisch reproduzierbaren Prozess Dokumentieren.
+|EN> Protocoll that documentates a process that can not be reproduced automatically.
+\end{itemize}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+