cryptocd/ccd-infos/entwicklungs-leitfaden.lyx

#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
\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
\papercolumns 1
\papersides 1
\paperpagestyle default
\tracking_changes false
\output_changes true
\end_header

\begin_body

\begin_layout Title
EntwicklerInnen-Leitfaden f<>r die CryptoCD
\end_layout

\begin_layout Standard
\begin_inset LatexCommand \tableofcontents{}

\end_inset


\end_layout

\begin_layout Section
Vorbereitung
\end_layout

\begin_layout Subsection
erforderliche Software
\end_layout

\begin_layout Standard
Die folgenden Programme ben<65>tigst du zur Weiterentwicklung der CryptoCD.
 In Klammern ist jeweils (als Beispiel) das dazugeh<65>rige Debian-Paket angegeben.
\end_layout

\begin_layout Itemize
make [make]
\end_layout

\begin_layout Itemize
lyx [lyx-qt | lyx-xforms]
\end_layout

\begin_layout Itemize
latex2html [latex2html]
\end_layout

\begin_layout Itemize
python [python]
\end_layout

\begin_layout Itemize
mkisofs [mkisofs]
\end_layout

\begin_layout Itemize
zip [zip]
\end_layout

\begin_layout Itemize
tar [tar]
\end_layout

\begin_layout Itemize
bzip2 [bzip2]
\end_layout

\begin_layout Itemize
subversion [subversion]
\end_layout

\begin_layout Itemize
linkchecker [linkchecker]
\end_layout

\begin_layout Itemize
html-validator [wdg-html-validator]
\end_layout

\begin_layout Itemize
unix2dos [tofrodos]
\end_layout

\begin_layout Subsection
Herunterladen der Entwickler-Version
\end_layout

\begin_layout Standard
Wir verwalten die Quell-Dateien der CryptoCD mit der Versionsverwaltung
 
\emph on
subversion
\emph default
.
 Mit dem folgenden Kommando erstellst du eine lokale Arbeitskopie der aktuellen
 Revision:
\end_layout

\begin_layout Quote
svn checkout https://svn.systemausfall.org/svn/cryptocd
\end_layout

\begin_layout Section
Bearbeitung der Anleitungstexte
\end_layout

\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
\end_layout

\begin_layout Subsection
Anpassung der Versionsnummer
\end_layout

\begin_layout Standard
Vor der Ver<65>ffentlichung einer neuen Version, m<>ssen die Versionnummern
 in folgenden Dokumenten angepasst werden:
\end_layout

\begin_layout Itemize
cover
\end_layout

\begin_layout Itemize
footer
\end_layout

\begin_layout Subsection
Changelog
\end_layout

\begin_layout Standard
Im Verzeichnis cd-template liegt die Datei 
\emph on
news.txt
\emph default
 - dort kannst du die <20>nderungen von Version zu Version erfassen.
\end_layout

\begin_layout Subsection
Finales Testen
\end_layout

\begin_layout Quote
make linkcheck
\end_layout

\begin_layout Quote
make validate
\end_layout

\begin_layout Subsection
Erstellung der Release-Dateien
\end_layout

\begin_layout Itemize
make all
\end_layout

\begin_deeper
\begin_layout Itemize
zip-Datei
\end_layout

\begin_layout Itemize
iso-Image
\end_layout

\begin_layout Itemize
source-bzip2
\end_layout

\end_deeper
\begin_layout Subsection
Hochladen zu eduforge.org
\end_layout

\begin_layout Subsubsection
Pakete
\end_layout

\begin_layout Standard
Um zu beobachten, wie h<>ufig die CryptoCD heruntergeladen wurde, empfielt
 es sich, alle Dateien <20>ber das sogenannte 
\emph on
file release system (frs)
\emph default
 anzubieten.
 Da der Upload <20>ber die Weboberfl<66>che nur f<>r Dateien bis zu 2 MB Gr<47>sse
 m<>glich ist, erfolgt der Upload per sftp.
 Dazu ben<65>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 Standard
Es ist wichtig, dass du die hochgeladenen Dateien anschlie<69>end mit Gruppen-Schre
ibrechten versiehst.
\end_layout

\begin_layout Standard
Nun m<>ssen die hochgeladenen Dateien im Eduforge-Download-Manager ver<65>ffentlicht
 werden:
\end_layout

\begin_layout Itemize
im Web-Interface anmelden
\end_layout

\begin_layout Itemize
Projekt 
\emph on
CryptoCD 
\emph default
ausw<EFBFBD>hlen
\end_layout

\begin_layout Itemize

\emph on
Admin -> Admin FRS -> Add Release
\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<EFBFBD>: 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
Anschlie<EFBFBD>end wird die Datei per sftp (Zugangsdaten siehe 3.5.1) in das Verzeichnis
 
\emph on
/home/groups/cryptocd/htdocs
\emph default
 hochgeladen.
\end_layout

\begin_layout Subsection
Werbung
\end_layout

\begin_layout Standard
Ank<EFBFBD>ndigung auf der mailingliste ...
\end_layout

\end_body
\end_document