.. DAK - Debian Archive Kit documentation master file.

Welcome to DAK_ - Debian Archive Kit's documentation!
====================================================

dak_ is the collection of programs used to maintain the Debian_
project's archives. It is highly optimized for the Debian_ project,
though can be (and is) used by others too.

More reading
-------------
**FIXME**: Convert to rst
There are some manual pages and READMEs in the [docs](docs) sub-directory.  The
[TODO](docs/TODO) file is an incomplete list of things needing to be done.

There's a mailinglist_ for discussion, development of and help with
dak.

Contributing
------------
We love to get patches for dak. Enhancements, bugfixes,
make-code-nicer/easier, anything.

Merge requests
+++++++++++++++
With dak_ being available at Salsa_, we now prefer receiving merge
requests there. They allow simple reviews using the webinterface and
also allow discussing (parts of) the code within the Salsa UI. They
also allow much easier tracking the state of different requests than a
mail on a list ever allows.

For more information on how to contribute please read the
debian-specific_ notes.

Setup dak
----------
You can find more info about setting dak_ up inside the [setup](setup)
Folder and its [README](setup/README).

API docs
=========

DAK_ consists of mostly python code, with the main scripts residing
inside the dak/ directory, an extensive python module store in daklib/
and a web api within dakweb/.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   generated/dak
   generated/daklib
   generated/dakweb

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

License
-------
dak_ is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2 of the License, a copy of which
is provided under the name COPYING, or (at your option) any later
version.

.. Links and Stuff
.. _dak: https://salsa.debian.org/ftp-team/dak
.. _Debian: https://www.debian.org/
.. _mailinglist: https://lists.debian.org/debian-dak/
.. _Salsa: http://salsa.debian.org/
.. _debian-specific: debian-specific.html
