Differences

This shows you the differences between two versions of the page.

--- devel:devel [2007/05/11 13:35] – created jodal
+++ devel:devel [2024/05/13 09:53] (current) – remove outdated links morten
@@ Line 3: / Line 3: @@
 In this section we intend to put all documentation targeted at NAV developers.
-First of all, all new developers should read the file HACKING at the root of our SVN repository. See [[http://svn.itea.ntnu.no/repos/nav/navme/trunk/HACKING]].
+===== Introduction to NAV development =====
-===== Libraries =====
+First of all, all new developers should read the [[HACKING]] document.
-==== Python Libraries ====
+  * [[Django introduction]] - An introduction to using Django with NAV
+  * [[PyCharm]] - Hacking with PyCharm
-  * Description: Python libraries & APIs. Please check what's already there before you roll your own.
+===== What to do? =====
-  * Source Location: subsystem/lib-python/
-  * Documentation: [[devel:lib-python]]
-==== Perl Libraries ====
+  * [[https://github.com/uninett/nav|GitHub issue tracker]]
-  * Description: Perl libraries & APIs. Please check what's already there before you roll your own.
-  * Source Location: subsystem/lib-perl/
-  * Documentation: [[devel:lib-perl]]
-==== Web Interface Libraries ====
+===== Subsystem documentation =====
-  * Description: Python libraries for the web interface (and front-page handler modules for mod_python).
+  * [[Libraries]] -- Common libraries shared by subsystems
-  * Source Location: subsystem/webfront/
+  * [[Processes]] -- Covers both network collection processes and data/maintenance processes
-  * Documentation: [[devel:webfront]]
+  * [[Web]] -- Covers the web toolbox with all its subsystems
+  * [[Cricket]] -- Covers Cricket, its web and RRD
-===== Network Collection Processes =====
+===== Data model documentation =====
-==== arplogger/iptrace ====
+  * [[Database]] -- Detailed information on the design of the NAV database
+  * [[Device data model]] -- Detailed information about how NAV maps the physical reality of devices into its internal data model
-  * Description: FIXME
-  * Language: Perl
-  * Process Type: Cron
-  * Source Location: src/getBoksMacs/
-  * Documentation: [[devel:arplogger]]
-==== mactrace/getBoksMacs ====
+===== Trivia =====
-  * Description: FIXME
+  * [[LinesOfCode]] compares the number of code lines and what programming languages are used in various NAV releases.
-  * Language: Java
-  * Process Type: Cron
-  * Source Location: src/getBoksMacs/
-  * Documentation: [[devel:mactrace]]
-==== getDeviceData ====
-  * Description: FIXME
-  * Language: Java
-  * Process Type: Daemon
-  * Source Location: src/getDeviceData/
-  * Documentation: [[devel:getdevicedata]]
-==== pping ====
-  * Description: FIXME
-  * Language: Python
-  * Process Type: Daemon
-  * Source Location: subsystems/statemon/
-  * Documentation: [[devel:pping]]
-==== serviceMon ====
-  * Description: FIXME
-  * Language: Python
-  * Process Type: Daemon
-  * Source Location: subsystems/statemon/
-  * Documentation: [[devel:servicemon]]
-===== Data/Maintenance Processes =====
-==== maintengine ====
-  * Description: FIXME
-  * Language: Python
-  * Process Type: Cron
-  * Source Location: subsystems/maintenance/
-  * Documentation: [[devel:maintengine]]
-==== networkDiscovery ====
-  * Description: FIXME
-  * Language: Java
-  * Process Type: Cron
-  * Source Location: subsystems/networkDiscovery/
-  * Documentation: [[devel:networkdiscovery]]
-==== logengine ====
-  * Description: FIXME
-  * Language: Python
-  * Process Type: Cron
-  * Source Location: FIXME
-  * Documentation: [[devel:logengine]]
-==== thresholdMon ====
-  * Description: FIXME
-  * Language: Python
-  * Process Type: Cron
-  * Source Location: subsystems/thresholdMon/
-  * Documentation: [[devel:thresholdmon]]
-==== eventEngine ====
-  * Description: FIXME
-  * Language: Java
-  * Process Type: Daemon
-  * Source Location: src/eventEngine/
-  * Documentation: [[devel:eventengine]]
-==== alertEngine ====
-  * Description: FIXME
-  * Language: Perl
-  * Process Type: Daemon
-  * Source Location: subsystems/alertEngine/
-  * Documentation: [[devel:alertengine]]
-==== smsd ====
-  * Description: The SMS daemon fetches alerts from the alert queue and sends them to NAV users by SMS.
-  * Language: Python
-  * Process Type: Daemon
-  * Source Location: subsystems/smsd/
-  * Documentation: [[devel:smsd]]
-===== Web Subsystems =====
-FIXME
-===== Cricket, Cricket Web and RRD =====
-FIXME