|
|
@@ -4,22 +4,35 @@ Misago Documentation
|
|
|
|
|
|
Welcome to Misago documentation!
|
|
|
|
|
|
+Misago is internet forum solution with many features aimed at different kinds of users. The aim for documentation is to provide refence and explanation of features available for them, allowing them to complete their taks better and more effectively.
|
|
|
+
|
|
|
.. warning::
|
|
|
- Works on documentation only recently have begun and are currently focused exclusively on developer oriented subjects.
|
|
|
+ Work on documentation has only just begun and currently all efford is focused exclusively on developer oriented subjects.
|
|
|
+
|
|
|
|
|
|
-Setup and Maintenance
|
|
|
+System Administrators
|
|
|
=====================
|
|
|
|
|
|
-(Documents about low level configuration (settings.py), available cron tasks, filestytem, installing, updating)
|
|
|
+System Administrators are users with direct access to server resources and services. This section covers Misago setup and update processes as well as live site maintenance.
|
|
|
+
|
|
|
+.. toctree::
|
|
|
+ :maxdepth: 1
|
|
|
+
|
|
|
+ sysadmins
|
|
|
+
|
|
|
|
|
|
+Users
|
|
|
+=====
|
|
|
|
|
|
-Customising Appearance
|
|
|
-======================
|
|
|
+This part of documentation is aimed at users who interact with Misago by the graphical UI available through internet browser. It's divided in three parts, with first one aimed for guests and signed in members posting on your forums, second one at moderators tasked by maintaining friendly atmosphere and finally third one for those who want to improve their knowledge and understanding of administration tools available in Admin Control Panel.
|
|
|
|
|
|
-Changing templates and assets (images, js, css), using pipeline, templates reference and coding guidelines for templates, css i js
|
|
|
+1. User Manual
|
|
|
+2. Moderator Manual
|
|
|
+3. Administrator Manual
|
|
|
|
|
|
|
|
|
-Writing New Code
|
|
|
-================
|
|
|
+Developers
|
|
|
+==========
|
|
|
|
|
|
-Coding guidelines for python files, links to Django doc's explaining their features, Misago API's and hooks references
|
|
|
+1. Changing Appearance
|
|
|
+2. Writing Extensions
|
Rafał Pitoń