diff --git a/ccd-infos/entwicklungs-leitfaden.lyx b/ccd-infos/entwicklungs-leitfaden.lyx index 84156d9..e2dfccd 100644 --- a/ccd-infos/entwicklungs-leitfaden.lyx +++ b/ccd-infos/entwicklungs-leitfaden.lyx @@ -1,139 +1,295 @@ -#LyX 1.3 created this file. For more info see http://www.lyx.org/ -\lyxformat 221 +#LyX 1.4.1 created this file. For more info see http://www.lyx.org/ +\lyxformat 245 +\begin_document +\begin_header \textclass article +\begin_preamble +\usepackage{hyperref} +\usepackage{html} +\usepackage{german} +\end_preamble \language english \inputencoding auto \fontscheme default \graphics default \paperfontsize default -\papersize Default -\paperpackage a4 -\use_geometry 0 -\use_amsmath 0 -\use_natbib 0 -\use_numerical_citations 0 +\spacing single +\papersize default +\use_geometry false +\use_amsmath 1 +\cite_engine basic +\use_bibtopic false \paperorientation portrait \secnumdepth 3 \tocdepth 3 \paragraph_separation indent \defskip medskip \quotes_language english -\quotes_times 2 \papercolumns 1 \papersides 1 \paperpagestyle default +\tracking_changes false +\output_changes true +\end_header -\layout Title +\begin_body +\begin_layout Title EntwicklerInnen-Leitfaden für die CryptoCD -\layout Section +\end_layout +\begin_layout Standard +\begin_inset LatexCommand \tableofcontents{} + +\end_inset + + +\end_layout + +\begin_layout Section Vorbereitung -\layout Subsection +\end_layout +\begin_layout Subsection erforderliche Software -\layout Standard +\end_layout +\begin_layout Standard Die folgenden Programme benötigst du zur Weiterentwicklung der CryptoCD. In Klammern ist jeweils (als Beispiel) das dazugehörige Debian-Paket angegeben. -\layout Itemize +\end_layout +\begin_layout Itemize make [make] -\layout Itemize +\end_layout +\begin_layout Itemize lyx [lyx-qt | lyx-xforms] -\layout Itemize +\end_layout +\begin_layout Itemize latex2html [latex2html] -\layout Itemize +\end_layout +\begin_layout Itemize python [python] -\layout Itemize +\end_layout -mkisofs [mkisofs -\layout Itemize +\begin_layout Itemize +mkisofs [mkisofs] +\end_layout +\begin_layout Itemize zip [zip] -\layout Itemize +\end_layout +\begin_layout Itemize tar [tar] -\layout Itemize +\end_layout +\begin_layout Itemize bzip2 [bzip2] -\layout Itemize +\end_layout +\begin_layout Itemize subversion [subversion] -\layout Itemize +\end_layout +\begin_layout Itemize linkchecker [linkchecker] -\layout Itemize +\end_layout +\begin_layout Itemize wdg-html-validator [wdg-html-validator] -\layout Itemize +\end_layout +\begin_layout Itemize unix2dos [tofrodos] -\layout Subsection +\end_layout +\begin_layout Subsection Herunterladen der Entwickler-Version -\layout Standard +\end_layout +\begin_layout Standard Wir verwalten die Quell-Dateien der CryptoCD mit der Versionsverwaltung -\emph on +\emph on subversion -\emph default +\emph default . Mit dem folgenden Kommando erstellst du eine lokale Arbeitskopie der aktuellen Revision: -\layout Quote +\end_layout +\begin_layout Quote svn checkout https://svn.systemausfall.org/svn/cryptocd -\layout Section +\end_layout +\begin_layout Section Bearbeitung der Anleitungstexte -\layout Standard +\end_layout -Hier sollte die Formatierungspolicy reinkommen - Menue, ... -\layout Section +\begin_layout Standard +Die Richtlinien zur Erstellung von neuen Anleitungen findest du hier: +\begin_inset Include \input{policy_formatierung.lyx} +preview false +\end_inset + + +\end_layout + +\begin_layout Section Release -\layout Subsection +\end_layout +\begin_layout Subsection Anpassung der Versionsnummer -\layout Itemize +\end_layout +\begin_layout Standard +Vor der Veröffentlichung einer neuen Version, müssen die Versionnummern + in folgenden Dokumenten angepasst werden: +\end_layout + +\begin_layout Itemize cover -\layout Itemize +\end_layout +\begin_layout Itemize footer -\layout Subsection +\end_layout +\begin_layout Subsection Changelog -\layout Subsection +\end_layout +\begin_layout Standard +Im Verzeichnis cd-template liegt die Datei +\emph on +news.txt +\emph default + - dort kannst du die Änderungen von Version zu Version erfassen. +\end_layout + +\begin_layout Subsection Finales Testen -\layout Quote +\end_layout +\begin_layout Quote make check -\layout Quote +\end_layout +\begin_layout Quote make validate -\layout Subsection +\end_layout +\begin_layout Subsection Erstellung der Release-Dateien -\layout Subsection +\end_layout -Hochladen -\layout Itemize +\begin_layout Subsection +Hochladen zu eduforge.org +\end_layout -eduforge - download -\layout Itemize +\begin_layout Subsubsection +Pakete +\end_layout -eduforge - online-Variante -\layout Subsection +\begin_layout Standard +Um zu beobachten, wie häufig die CryptoCD heruntergeladen wurde, empfielt + es sich, alle Dateien über das sogenannte +\emph on +file release system (frs) +\emph default + anzubieten. + Da der Upload über die Weboberfläche nur für Dateien bis zu 2 MB Grösse + möglich ist, erfolgt der Upload per sftp. + Dazu benötigst du folgende Daten: +\end_layout +\begin_layout Itemize +Rechner: shell.eduforge.org +\end_layout + +\begin_layout Itemize +Login: deinE eduforge NutzerIn +\end_layout + +\begin_layout Itemize +Protokoll: ssh2 (sftp) +\end_layout + +\begin_layout Itemize +Upload-Verzeichnis: sftp://ftp.eduforge.org/home/pub/cryptocd/ +\end_layout + +\begin_layout Subsubsection +Online-Version +\end_layout + +\begin_layout Standard +Um die Online-Version hochzuladen, loggst du dich erneut per sftp bei eduforge + ein (Daten siehe oben). + Anschliessend wechselst du in das Verzeichis / +\emph on +home/groups/cryptocd/htdocs/online_version +\emph default + und legst ein entsprechendes Unterverzeichnis für die jeweilige Version + an. +\end_layout + +\begin_layout Subsection +Anpassen der cryptocd.org-Seite +\end_layout + +\begin_layout Standard +Im svn befindet sich das Verzeichnis +\emph on +eduforge +\emph default +. + Die Datei +\emph on +index.html +\emph default + ist die Seite, die nach einem Aufruf von cryptocd.org angezeigt wird. + Erscheint eine neue Version, so müssen folgende Abschnitte angepasst werden: +\end_layout + +\begin_layout Itemize +Menü: Link zur Online-Version anpassen +\end_layout + +\begin_layout Itemize +Neues: kurzer Text zur neuen Version und changelog +\end_layout + +\begin_layout Itemize +Download: die Links und Versionsnummern entsprechend anpassen +\end_layout + +\begin_layout Itemize +Online-Version: Link anpassen +\end_layout + +\begin_layout Standard +Anschliessend wird die Datei per sftp (Zugangsdaten siehe 3.5.1) in das Verzeichni +s +\emph on +/home/groups/cryptocd/htdocs +\emph default + hochgeladen. +\end_layout + +\begin_layout Subsection Werbung -\layout Standard +\end_layout +\begin_layout Standard Ankündigung auf der mailingliste ... -\the_end +\end_layout + +\end_body +\end_document