Download as
Browse Code »

Commit 68facd63ff5163ddf9958cbe598fb2de4cc11e0a

Authored by Gust
1 parent 11421f15
Exists in master and in 34 other branches 1.12.x, add_requests_as_dep, celery_service, change-passwd-signal, check-port, colab-signals, colab-vcard, colab_search, colab_tag, colab_tag_merge, community_association, detach_super_archives, fix-dashboard, fix-message-preview, fix_app_label, fix_header, fixed_gitlab_import, go_to_profile_panel, mobile_user_scalable, move_out_plugins, paginate-threads, profile_integration, refactor-data-import, remove-gitlab-plugin, removing_namespace, search_block, search_filters, split_screen, startplugin, timestamp_plugins, translation_review, user_regex, validate-passwd, workin_whoosh_temp

Add user documentation 

Signed-off-by: Gustavo Jaruga <darksshades@gmail.com>
Signed-off-by: Carolina Ramalho <carol15022@hotmail.com>
Signed-off-by: Alexandre Barbosa <alexandreab@live.com>
Showing 1 changed file with 57 additions and 1 deletions   Show diff stats
docs/source/user.rst
  Diff comments   View file @68facd6
... ... @@ -14,7 +14,63 @@ Install
14 14  
15 15 Plugins
16 16 -------
17   -.. TODO
  17 +.. attribute:: COLAB_APPS
  18 +
  19 + :default: None
  20 +
  21 + Describes the activated plugins and its configurations. It's necessary to describe
  22 + for each app its name as the variable. The apps described here can be devided into
  23 + two categories, that beeing, colab proxy apps and third-party apps.
  24 + The upstream variable is only needed to colab proxy apps.
  25 +
  26 +.. attribute:: upstream
  27 +
  28 +Declares the upstream server url of the proxy.
  29 +
  30 +menu
  31 +++++++++++++
  32 +
  33 +.. attribute:: title
  34 +
  35 + Declares the menu title.
  36 +.. attribute:: links
  37 +
  38 + Declares the menu items and its links.
  39 +.. attribute:: auth_links
  40 +
  41 + Declares the menu items and its links when the user authenticated.
  42 +.. attribute:: dependecies
  43 +
  44 +Declares a list of the plugin dependecies.
  45 +
  46 +urls
  47 +++++++++++++
  48 +
  49 +.. attribute:: include
  50 +
  51 + Declares the include urls.
  52 +.. attribute:: prefix
  53 +
  54 + Declares the prefix for the url.
  55 +.. attribute:: namespace
  56 +
  57 + Declares the namespace for the url.
  58 +
  59 +templates
  60 +++++++++++++
  61 +
  62 +.. attribute:: context_processors
  63 +
  64 + Declares the plugin context processors.
  65 +.. attribute:: templatesdir
  66 +
  67 + Declares the path to templates directory.
  68 +.. attribute:: staticdir
  69 +
  70 + Declares the path to static directory.
  71 +.. attribute:: localesdir
  72 +
  73 + Declares the path to locales directory.
18 74  
19 75 Settings
20 76 --------
... ...