summaryrefslogtreecommitdiff
path: root/Development_Manual
diff options
context:
space:
mode:
authorJeroen van Meeuwen (Ergo Project) <jeroen.van.meeuwen@ergo-project.org>2011-01-05 23:42:56 (GMT)
committerJeroen van Meeuwen (Ergo Project) <jeroen.van.meeuwen@ergo-project.org>2011-01-05 23:42:56 (GMT)
commit4d849a6e64d30d8d1f29b8d82f87f692d617069b (patch)
treea827a49c142cd188f3677586d7f10941b24f9874 /Development_Manual
parent090f09897fa635c5b844fc7046fb1eaa6e181adb (diff)
downloadkolab-docs-4d849a6e64d30d8d1f29b8d82f87f692d617069b.tar.gz
Updates to the documentation
Diffstat (limited to 'Development_Manual')
-rw-r--r--Development_Manual/Makefile17
-rw-r--r--Development_Manual/en-US/Author_Group.xml7
-rw-r--r--Development_Manual/en-US/Book_Info.xml43
-rw-r--r--Development_Manual/en-US/Chapter.xml54
-rw-r--r--Development_Manual/en-US/Development_Manual.xml9
-rw-r--r--Development_Manual/en-US/Development_Processes.xml39
-rw-r--r--Development_Manual/en-US/Documentation.xml16
-rw-r--r--Development_Manual/en-US/General_Kolab_Server_Components_Packaging_Notes.xml5
-rw-r--r--Development_Manual/en-US/Localization_and_Internationalization.xml23
-rw-r--r--Development_Manual/en-US/Packaging_Kolab_Components.xml13
-rw-r--r--Development_Manual/en-US/Packaging_Kolab_Server_Components_with_RPM.xml73
-rw-r--r--Development_Manual/en-US/Packaging_with_APT.xml361
-rw-r--r--Development_Manual/en-US/Packaging_with_RPM.xml93
-rw-r--r--Development_Manual/en-US/Part-General_Kolab_Packaging_Notes.xml6
-rw-r--r--Development_Manual/en-US/Part-Kolab_Packaging_with_RPM.xml11
-rw-r--r--Development_Manual/en-US/Preface.xml9
-rw-r--r--Development_Manual/en-US/Revision_History.xml44
-rw-r--r--Development_Manual/en-US/TODO.xml20
18 files changed, 660 insertions, 183 deletions
diff --git a/Development_Manual/Makefile b/Development_Manual/Makefile
new file mode 100644
index 0000000..bef33ef
--- /dev/null
+++ b/Development_Manual/Makefile
@@ -0,0 +1,17 @@
+PACKAGE = "Development_Manual"
+
+all: clean clean_ids
+ @publican build --langs=en-US --formats=html,html-single,pdf
+ @rsync -aHvz tmp/en-US/{html,html-single,pdf} hosted.kolabsys.com:./public_html/kolab-2.3-docs/$(PACKAGE)/
+
+clean:
+ @publican clean
+
+clean_ids:
+ @cp -a ../Common_Content/en-US/*.xml en-US/.
+ @publican clean_ids
+ @sed -i -r \
+ -e 's/\t/ /g' \
+ -e 's/((\s{4})+)\s*/\1/g' \
+ -e 's/\s*$$//g' \
+ `find en-US/ -type f -name "*.xml"`
diff --git a/Development_Manual/en-US/Author_Group.xml b/Development_Manual/en-US/Author_Group.xml
index 98ecc97..d8fc01c 100644
--- a/Development_Manual/en-US/Author_Group.xml
+++ b/Development_Manual/en-US/Author_Group.xml
@@ -7,12 +7,13 @@
<author>
<firstname>Jeroen</firstname>
<surname>van Meeuwen</surname>
- <lineage>RHCE</lineage>
- <affiliation>
+ <lineage>RHCE</lineage> <affiliation>
<orgname>Kolab Systems</orgname>
- <orgdiv>Senior Engineer</orgdiv>
+ <orgdiv>Engineering</orgdiv>
+
</affiliation>
<email>vanmeeuwen@kolabsys.com</email>
+
</author>
</authorgroup>
diff --git a/Development_Manual/en-US/Book_Info.xml b/Development_Manual/en-US/Book_Info.xml
index e129ee3..0738933 100644
--- a/Development_Manual/en-US/Book_Info.xml
+++ b/Development_Manual/en-US/Book_Info.xml
@@ -4,25 +4,28 @@
%BOOK_ENTITIES;
]>
<bookinfo id="book-Development_Manual-Development_Manual">
- <title>Development Manual</title>
- <subtitle>short description</subtitle>
- <productname>Kolab</productname>
- <productnumber>2.3.0</productnumber>
- <edition>1</edition>
- <pubsnumber>0</pubsnumber>
- <abstract>
- <para>
- A short overview and summary of the book's subject and purpose, traditionally no more than one paragraph long. Note: the abstract will appear in the front matter of your book and will also be placed in the description field of the book's RPM spec file.
- </para>
- </abstract>
- <corpauthor>
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" />
- </imageobject>
- </inlinemediaobject>
- </corpauthor>
- <xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <title>Development Manual</title>
+ <subtitle>short description</subtitle>
+ <productname>Kolab</productname>
+ <productnumber>2.3.0</productnumber>
+ <edition>1</edition>
+ <pubsnumber>0</pubsnumber>
+ <abstract>
+ <para>
+ A short overview and summary of the book's subject and purpose, traditionally no more than one paragraph long. Note: the abstract will appear in the front matter of your book and will also be placed in the description field of the book's RPM spec file.
+ </para>
+
+ </abstract>
+ <corpauthor>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" />
+ </imageobject>
+
+ </inlinemediaobject>
+
+ </corpauthor>
+ <xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</bookinfo>
diff --git a/Development_Manual/en-US/Chapter.xml b/Development_Manual/en-US/Chapter.xml
index 056487f..13beca1 100644
--- a/Development_Manual/en-US/Chapter.xml
+++ b/Development_Manual/en-US/Chapter.xml
@@ -4,30 +4,36 @@
%BOOK_ENTITIES;
]>
<chapter id="chap-Development_Manual-Test_Chapter">
- <title>Test Chapter</title>
- <para>
- This is a test paragraph
- </para>
- <section id="sect-Development_Manual-Test_Chapter-Test_Section_1">
- <title>Test Section 1</title>
- <para>
- This is a test paragraph in a section
- </para>
- </section>
-
- <section id="sect-Development_Manual-Test_Chapter-Test_Section_2">
- <title>Test Section 2</title>
- <para>
- This is a test paragraph in Section 2
- <orderedlist>
- <listitem>
- <para>
- listitem text
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
+ <title>Test Chapter</title>
+ <para>
+ This is a test paragraph
+ </para>
+ <section id="sect-Development_Manual-Test_Chapter-Test_Section_1">
+ <title>Test Section 1</title>
+ <para>
+ This is a test paragraph in a section
+ </para>
+
+ </section>
+
+ <section id="sect-Development_Manual-Test_Chapter-Test_Section_2">
+ <title>Test Section 2</title>
+ <para>
+ This is a test paragraph in Section 2
+ <orderedlist>
+ <listitem>
+ <para>
+ listitem text
+ </para>
+
+ </listitem>
+
+ </orderedlist>
+
+ </para>
+
+ </section>
+
</chapter>
diff --git a/Development_Manual/en-US/Development_Manual.xml b/Development_Manual/en-US/Development_Manual.xml
index dede735..68d6bd5 100644
--- a/Development_Manual/en-US/Development_Manual.xml
+++ b/Development_Manual/en-US/Development_Manual.xml
@@ -6,10 +6,11 @@
<book>
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
- <xi:include href="Part-General_Kolab_Packaging_Notes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Part-Kolab_Packaging_with_RPM.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
+ <xi:include href="Development_Processes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Documentation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Localization_and_Internationalization.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Packaging_with_APT.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Packaging_with_RPM.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<index />
</book>
diff --git a/Development_Manual/en-US/Development_Processes.xml b/Development_Manual/en-US/Development_Processes.xml
new file mode 100644
index 0000000..25c1559
--- /dev/null
+++ b/Development_Manual/en-US/Development_Processes.xml
@@ -0,0 +1,39 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<part id="part-Development_Manual-Development_Processes">
+ <title>Development Processes</title>
+ <chapter id="chap-Development_Manual-Development_Processes-Development_and_Release_Cycles">
+ <title>Development and Release Cycles</title>
+ <para>
+ para
+ </para>
+
+ </chapter>
+ <chapter id="chap-Development_Manual-Development_Processes-Release_and_Support_Cycles">
+ <title>Release and Support Cycles</title>
+ <para>
+ para
+ </para>
+ <section id="sect-Development_Manual-Release_and_Support_Cycles-Product_Series_and_Platform_Support">
+ <title>Product Series and Platform Support</title>
+ <para>
+ The support of a product series packaged for or deployed on any particular platform continues for as long as the upstream party for the platform continues to support the actual platform. In other words, in terms of Kolab 2.2 being supported on Debian Lenny at the time of this writing, the support for Kolab 2.2 on Debian Lenny will continue for as long as Debian Lenny is supported by Debian itself.
+ </para>
+
+ </section>
+
+
+ </chapter>
+ <chapter id="chap-Development_Manual-Development_Processes-Kolab_Enhancement_Proposals">
+ <title>Kolab Enhancement Proposals</title>
+ <para>
+ para
+ </para>
+
+ </chapter>
+
+</part>
+
diff --git a/Development_Manual/en-US/Documentation.xml b/Development_Manual/en-US/Documentation.xml
new file mode 100644
index 0000000..f73fce4
--- /dev/null
+++ b/Development_Manual/en-US/Documentation.xml
@@ -0,0 +1,16 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<part id="part-Development_Manual-Documentation">
+ <title>Documentation</title>
+ <chapter id="chap-Development_Manual-Documentation-Kolab_Server">
+ <title>Kolab Server</title>
+ <para>
+ para
+ </para>
+
+ </chapter>
+</part>
+
diff --git a/Development_Manual/en-US/General_Kolab_Server_Components_Packaging_Notes.xml b/Development_Manual/en-US/General_Kolab_Server_Components_Packaging_Notes.xml
index 2bc0392..bf2d99d 100644
--- a/Development_Manual/en-US/General_Kolab_Server_Components_Packaging_Notes.xml
+++ b/Development_Manual/en-US/General_Kolab_Server_Components_Packaging_Notes.xml
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Manual.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
%BOOK_ENTITIES;
]>
<chapter id="chap-Development_Manual-General_Kolab_Server_Components_Packaging_Notes">
@@ -11,8 +11,11 @@
<para>
requires being started after ldap server (standalone)
</para>
+
</listitem>
+
</itemizedlist>
+
</para>
</chapter>
diff --git a/Development_Manual/en-US/Localization_and_Internationalization.xml b/Development_Manual/en-US/Localization_and_Internationalization.xml
new file mode 100644
index 0000000..220eeba
--- /dev/null
+++ b/Development_Manual/en-US/Localization_and_Internationalization.xml
@@ -0,0 +1,23 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<part id="part-Development_Manual-Localization_and_Internationalization">
+ <title>Localization and Internationalization</title>
+ <chapter id="chap-Development_Manual-Localization_and_Internationalization-Desktop_Components">
+ <title>Desktop Components</title>
+ <para>
+ para
+ </para>
+
+ </chapter>
+ <chapter id="chap-Development_Manual-Localization_and_Internationalization-Web_Interfaces">
+ <title>Web Interfaces</title>
+ <para>
+ para
+ </para>
+
+ </chapter>
+</part>
+
diff --git a/Development_Manual/en-US/Packaging_Kolab_Components.xml b/Development_Manual/en-US/Packaging_Kolab_Components.xml
deleted file mode 100644
index 2dae317..0000000
--- a/Development_Manual/en-US/Packaging_Kolab_Components.xml
+++ /dev/null
@@ -1,13 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Manual.ent">
-%BOOK_ENTITIES;
-]>
-<chapter id="chap-Development_Manual-Packaging_Kolab_Components">
- <title>Packaging Kolab Components</title>
- <para>
- About
- </para>
-
-</chapter>
-
diff --git a/Development_Manual/en-US/Packaging_Kolab_Server_Components_with_RPM.xml b/Development_Manual/en-US/Packaging_Kolab_Server_Components_with_RPM.xml
deleted file mode 100644
index 5353477..0000000
--- a/Development_Manual/en-US/Packaging_Kolab_Server_Components_with_RPM.xml
+++ /dev/null
@@ -1,73 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Manual.ent">
-%BOOK_ENTITIES;
-]>
-<chapter id="chap-Development_Manual-Packaging_Kolab_Server_Components_with_RPM">
- <title>Packaging Kolab Server Components with RPM</title>
- <para>
- Kolab Groupware exists of several components. On the server side, we have:
- </para>
- <para>
- <itemizedlist>
- <listitem>
- <para>
- <literal>kolab</literal>
- </para>
- </listitem>
- <listitem>
- <para>
- FIXME: List the rest of the packages
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <section>
- <title>kolab-cyrus-imapd</title>
- <para>
- Requirements:
- </para>
- <para>
- <itemizedlist>
- <listitem>
- <para>
- <literal>perl-TermReadKey</literal> for perl(Term::ReadKey) capabilities
- </para>
- <para>
- The package is required for %{_bindir}/cyradm
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </section>
-
- <section>
- <title>Checklist Notes</title>
- <para>
- <itemizedlist>
- <listitem>
- <para>
- Creation of user
- </para>
- </listitem>
- <listitem>
- <para>
- chkconfig --add services
- </para>
- </listitem>
- <listitem>
- <para>
- Set debug to 9 (/etc/kolab/kolab.globals)
- </para>
- </listitem>
- <listitem>
- <para>
- Set loglevel to 15 (/etc/kolab/kolab.globals)
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </section>
-</chapter>
-
diff --git a/Development_Manual/en-US/Packaging_with_APT.xml b/Development_Manual/en-US/Packaging_with_APT.xml
new file mode 100644
index 0000000..cbffc75
--- /dev/null
+++ b/Development_Manual/en-US/Packaging_with_APT.xml
@@ -0,0 +1,361 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<part id="part-Development_Manual-Packaging_with_APT">
+ <title>Packaging with APT</title>
+ <chapter id="chap-Development_Manual-Packaging_with_APT-Prerequisites">
+ <title>Prerequisites</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ A 64-bit system with Debian Squeeze or later,
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ The following packages:
+ </para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ cowbuilder
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ dupload
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ git-buildpackage
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ git-core
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ git-svn
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ pbuilder
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ quilt
+ </para>
+
+ </listitem>
+
+ </itemizedlist>
+
+ </para>
+
+ </listitem>
+
+ </itemizedlist>
+
+ </para>
+ <note>
+ <title>Not Including Build Requirements</title>
+ <para>
+ Note that the list of required packages does not include any build requirements for any of the packages.
+ </para>
+
+ </note>
+ <para>
+ You may install these packages in one go using the following command:
+ </para>
+ <para>
+
+<screen># <userinput>apt-get -y install cowbuilder dupload fakeroot git-buildpackage \</userinput>
+ <userinput> git-core git-svn pbuilder quilt</userinput></screen>
+
+ </para>
+
+ </chapter>
+ <chapter id="chap-Development_Manual-Packaging_with_APT-Getting_Started">
+ <title>Getting Started</title>
+ <para>
+ We perform packaging from GIT source code management repositories. Using these repositories, either as a separate remote for an upstream GIT repository, or as a pristine-tar import based exploded tree, patch management as well as Debian APT packaging semantics are maintained in such GIT repository.
+ </para>
+ <para>
+ The upstream source code management for programs for which Kolab itself is the upstream, holds no information relevant to packaging semantics for any given distribution.
+ </para>
+ <para>
+ To clone an APT packaging repository, use:
+ </para>
+ <para>
+
+<screen>$ <userinput>git clone git://git.kolabsys.com/git/apt/$package</userinput></screen>
+
+ </para>
+ <para>
+ where <emphasis>$package</emphasis> is one of the packages in <xref linkend="item-Development_Manual-APT_Packaging_GIT_Repositories-APT_Packages" />.
+ </para>
+ <section id="sect-Development_Manual-Getting_Started-APT_Packaging_GIT_Repositories">
+ <title>APT Packaging GIT Repositories</title>
+ <para>
+ The APT packaging GIT repositories live at: <ulink url="http://git.kolabsys.com/apt/" />. Each source package has its own GIT repository. The following repositories are relevant:
+ </para>
+ <para>
+ <itemizedlist id="item-Development_Manual-APT_Packaging_GIT_Repositories-APT_Packages">
+ <title>APT Packages</title>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-cyrus_imapd">
+ <title><application>cyrus-imapd</application></title>
+ <para>
+ Kolab currently maintains a set of requirements to Cyrus IMAP that is not provided through Debian nor Ubuntu native packages included in the distribution's package repositories, including, but not limited to:
+ </para>
+
+ </formalpara>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Kolab annotation configuration support.
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ Login with uid and/or mail attribute.
+ </para>
+
+ </listitem>
+
+ </itemizedlist>
+
+ </para>
+ <para>
+ Additionally, the Kolab version for hosted providers requires Cyrus IMAP 2.4.
+ </para>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-horde3">
+ <title><application>horde3</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-horde4">
+ <title><application>horde4</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-kolab_webadmin">
+ <title><application>kolab-webadmin</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-kolab_webclient">
+ <title><application>kolab-webclient</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-kolabd">
+ <title><application>kolabd</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-libkolab_perl">
+ <title><application>libkolab-perl</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-libnet_ldap_perl">
+ <title><application>libnet-ldap-perl</application></title>
+ <para>
+ Kolab's perl libraries require a more recent version of libnet-ldap-perl then is available in Debian Lenny.
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-php">
+ <title><application>php</application></title>
+ <para>
+ Kolab ships IMAP annotation and myrights patches against PHP.
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-php_kolab_config">
+ <title><application>php-kolab-config</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-php_kolab_filter">
+ <title><application>php-kolab-filter</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-php_kolab_format">
+ <title><application>php-kolab-format</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-php_kolab_freebusy">
+ <title><application>php-kolab-freebusy</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-php_kolab_resource">
+ <title><application>php-kolab-resource</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-php_kolab_server">
+ <title><application>php-kolab-server</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-php_kolab_storage">
+ <title><application>php-kolab-storage</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-php_kolab_zpush">
+ <title><application>php-kolab-zpush</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-php_net_ldap2">
+ <title><application>php-net-ldap2</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-uw_imap">
+ <title><application>uw-imap</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+
+ </itemizedlist>
+
+ </para>
+ <section id="sect-Development_Manual-APT_Packaging_GIT_Repositories-SCM_Branch_Policy">
+ <title>SCM Branch Policy</title>
+ <para>
+ A GIT repository has a master branch, which corresponds with the most bleeding edge version of Kolab, and the most bleeding edge version of the distribution (e.g. Debian Sid).
+ </para>
+ <para>
+ The following naming convention is used for more stabilized distribution version product series:
+ </para>
+ <para>
+
+<screen>$distribution / [$codename /] $product_name - $product_version_series</screen>
+
+ </para>
+ <para>
+ This means that, for example, packaging semantics for Kolab 2.2 specific to Lenny are put in <literal>debian/lenny/kolab-2.2</literal>, such as, for example, is the case with PHP: <ulink url="http://git.kolabsys.com/apt/php/log/?h=debian/lenny/kolab-2.2" /> where Kolab 2.2 shipped a modified version of <application>php5</application>, built against a modified version of <application>uw-imap</application>, to enable IMAP annotation support.
+ </para>
+
+ </section>
+
+
+ </section>
+
+
+ </chapter>
+</part>
+
diff --git a/Development_Manual/en-US/Packaging_with_RPM.xml b/Development_Manual/en-US/Packaging_with_RPM.xml
new file mode 100644
index 0000000..f8ab832
--- /dev/null
+++ b/Development_Manual/en-US/Packaging_with_RPM.xml
@@ -0,0 +1,93 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<part id="part-Development_Manual-Packaging_with_RPM">
+ <title>Packaging with RPM</title>
+ <chapter id="chap-Development_Manual-Packaging_with_RPM-Packaging_with_RPM">
+ <title>Packaging with RPM</title>
+ <para>
+ Kolab Groupware exists of several components. On the server side, we have:
+ </para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <literal>kolab</literal>
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ FIXME: List the rest of the packages
+ </para>
+
+ </listitem>
+
+ </itemizedlist>
+
+ </para>
+ <section id="sect-Development_Manual-Packaging_with_RPM-kolab_cyrus_imapd">
+ <title>kolab-cyrus-imapd</title>
+ <para>
+ Requirements:
+ </para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <literal>perl-TermReadKey</literal> for perl(Term::ReadKey) capabilities
+ </para>
+ <para>
+ The package is required for %{_bindir}/cyradm
+ </para>
+
+ </listitem>
+
+ </itemizedlist>
+
+ </para>
+
+ </section>
+
+ <section id="sect-Development_Manual-Packaging_with_RPM-Checklist_Notes">
+ <title>Checklist Notes</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Creation of user
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ chkconfig --add services
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ Set debug to 9 (/etc/kolab/kolab.globals)
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ Set loglevel to 15 (/etc/kolab/kolab.globals)
+ </para>
+
+ </listitem>
+
+ </itemizedlist>
+
+ </para>
+
+ </section>
+
+
+ </chapter>
+
+</part>
+
diff --git a/Development_Manual/en-US/Part-General_Kolab_Packaging_Notes.xml b/Development_Manual/en-US/Part-General_Kolab_Packaging_Notes.xml
index 19e6af4..5779cd0 100644
--- a/Development_Manual/en-US/Part-General_Kolab_Packaging_Notes.xml
+++ b/Development_Manual/en-US/Part-General_Kolab_Packaging_Notes.xml
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Manual.ent">
+<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
%BOOK_ENTITIES;
]>
<part id="part-Development_Manual-General_Kolab_Packaging_Notes">
<title>General Kolab Packaging Notes</title>
-
<xi:include href="General_Kolab_Server_Components_Packaging_Notes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</part>
+
diff --git a/Development_Manual/en-US/Part-Kolab_Packaging_with_RPM.xml b/Development_Manual/en-US/Part-Kolab_Packaging_with_RPM.xml
deleted file mode 100644
index 72a9502..0000000
--- a/Development_Manual/en-US/Part-Kolab_Packaging_with_RPM.xml
+++ /dev/null
@@ -1,11 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Manual.ent">
-%BOOK_ENTITIES;
-]>
-<part id="part-Development_Manual-Kolab_Packaging_with_RPM">
- <title>Kolab Packaging with RPM</title>
-
- <xi:include href="Packaging_Kolab_Server_Components_with_RPM.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
-</part> \ No newline at end of file
diff --git a/Development_Manual/en-US/Preface.xml b/Development_Manual/en-US/Preface.xml
index e68be4c..6cea477 100644
--- a/Development_Manual/en-US/Preface.xml
+++ b/Development_Manual/en-US/Preface.xml
@@ -4,10 +4,9 @@
%BOOK_ENTITIES;
]>
<preface id="pref-Development_Manual-Preface">
- <title>Preface</title>
- <xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- </xi:fallback>
- </xi:include>
+ <title>Preface</title>
+ <xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="sect-Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="sect-About_Kolab_Groupware.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</preface>
diff --git a/Development_Manual/en-US/Revision_History.xml b/Development_Manual/en-US/Revision_History.xml
index 99e8c7d..d691932 100644
--- a/Development_Manual/en-US/Revision_History.xml
+++ b/Development_Manual/en-US/Revision_History.xml
@@ -4,24 +4,30 @@
%BOOK_ENTITIES;
]>
<appendix id="appe-Development_Manual-Revision_History">
- <title>Revision History</title>
- <simpara>
- <revhistory>
- <revision>
- <revnumber>0</revnumber>
- <date>Sun May 16 2010</date>
- <author>
- <firstname>Dude</firstname>
- <surname>McPants</surname>
- <email>Dude.McPants@example.com</email>
- </author>
- <revdescription>
- <simplelist>
- <member>Initial creation of book by publican</member>
- </simplelist>
- </revdescription>
- </revision>
- </revhistory>
- </simpara>
+ <title>Revision History</title>
+ <simpara>
+ <revhistory>
+ <revision>
+ <revnumber>0</revnumber>
+ <date>Sun May 16 2010</date>
+ <author>
+ <firstname>Dude</firstname>
+ <surname>McPants</surname>
+ <email>Dude.McPants@example.com</email>
+
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Initial creation of book by publican</member>
+
+ </simplelist>
+
+ </revdescription>
+
+ </revision>
+
+ </revhistory>
+
+ </simpara>
</appendix>
diff --git a/Development_Manual/en-US/TODO.xml b/Development_Manual/en-US/TODO.xml
index fd74174..397b467 100644
--- a/Development_Manual/en-US/TODO.xml
+++ b/Development_Manual/en-US/TODO.xml
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Manual.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Development_Manual-TODO">
+<chapter id="chap-Development_Manual-List_of_things_to_do">
<title>List of things to do</title>
<para>
<itemizedlist>
@@ -11,41 +11,47 @@
<para>
provide a means for kolabd to poll and continue operations as normal, rather then fail on error and stop
</para>
+
</listitem>
<listitem>
<para>
the setup program is actually supposed to be called setup-kolab
</para>
+
</listitem>
<listitem>
<para>
keep account of steps completed in the setup program, so that we can continue
</para>
+
</listitem>
<listitem>
<para>
password prompt on setup should not echo
</para>
+
</listitem>
<listitem>
<para>
could not write to /usr/lib64/sasl2/smtpd.conf at /usr/sbin/kolab_bootstrap line 465, &lt;STDIN&gt; line 6.
</para>
+
</listitem>
<listitem>
<para>
- chgrp /etc/kolab/key.pem /etc/kolab/cert.pem
-chgrp: invalid group `/etc/kolab/key.pem'
-system chgrp /etc/kolab/key.pem /etc/kolab/cert.pem failed: 256 at /usr/sbin/kolab_bootstrap line 193, &lt;STDIN&gt; line 7.
+ chgrp /etc/kolab/key.pem /etc/kolab/cert.pem chgrp: invalid group `/etc/kolab/key.pem' system chgrp /etc/kolab/key.pem /etc/kolab/cert.pem failed: 256 at /usr/sbin/kolab_bootstrap line 193, &lt;STDIN&gt; line 7.
</para>
+
</listitem>
<listitem>
<para>
- May 17 09:25:56 laurel perl: No worthy mechs found
-May 17 09:25:56 laurel imap[2587]: auxpropfunc error invalid parameter supplied
+ May 17 09:25:56 laurel perl: No worthy mechs found May 17 09:25:56 laurel imap[2587]: auxpropfunc error invalid parameter supplied
</para>
+
</listitem>
+
</itemizedlist>
+
</para>
</chapter>