IntenseWebs/freeipa
3
0
Fork 0
mirror of https://salsa.debian.org/freeipa-team/freeipa.git synced 2024-12-25 16:31:08 -06:00
Code Issues Packages Projects Releases Wiki Activity
227cf8d4e9
freeipa/doc/guide
History
Jan Cholasta fe6f2b6f6e scripts, tests: explicitly set confdir in the rest of server code 
Commit 1e6a204b43 added explicit confdir
setting to api.bootstrap() calls of a randomly selected portion of
server-side scripts and tests. This commit adds it to the rest of
server-side code for consistency.

https://fedorahosted.org/freeipa/ticket/6389

Reviewed-By: Stanislav Laznicka <slaznick@redhat.com>
2017-02-22 08:07:48 +00:00
..
guide.org Docs: update docs about ipaplatform to match reality 2016-10-24 13:30:12 +02:00
Makefile Add "Extending FreeIPA" developer guide 2011-11-22 15:52:02 +02:00
netgroup.js Add "Extending FreeIPA" developer guide 2011-11-22 15:52:02 +02:00
README Add "Extending FreeIPA" developer guide 2011-11-22 15:52:02 +02:00
role.py.txt Rename included snippets to avoid problems with pylint 2011-11-22 17:04:03 +02:00
wsgi.py.txt scripts, tests: explicitly set confdir in the rest of server code 2017-02-22 08:07:48 +00:00

README 

Extending FreeIPA
-----------------

"Extending FreeIPA" is a developer guide to understand how FreeIPA core 
framework is built and how to extend it.

The Guide is written using Emacs Org Mode, see http://orgmode.org/org.html
for extensive manual of supported markup features.

You don't need to use Emacs to edit it, the markup is a plain text.

Building the guide
------------------

There is Makefile which can be used to convert the Guide from
Emacs Org Mode format to different targets.

Prerequisites:
==============
On Fedora system following packages are required to generate The Guide:

docbook-style-xsl
fop
emacs
xmlto

HTML, Docbook, and plain text
---
As Org Mode is part of Emacs since version 22, building HTML, TXT, and 
Docbook targets requires Emacs v22 and above (tested with v23.3 in Fedora).

PDF
---
Building PDF is done first generating Docbook source, converting it to FO format,
and then running 'fop' processor.