Update user documentation

- Change order to create a folder before create the file - Add description of private_token - Add exemple of usage application_prefix

Update user documentation
- Change order to create a folder before create the file - Add description of private_token - Add exemple of usage application_prefix
Luciano Prestes
1 parent 152ebd04
Showing 1 changed file with 8 additions and 4 deletions Show diff stats
docs/source/user.rst
@@ -73,10 +73,10 @@ Add a new plugin
  
 - Create the plugin configuration for the application
  
-  - create file: [plugin_name].py
-
   - on folder: /etc/colab/plugins.d/
  
+  - create file: [plugin_name].py
+
 Use this template for the plugin configuration file
  
 .. code-block:: python
@@ -87,12 +87,16 @@ Use this template for the plugin configuration file
     name = 'colab.plugins.[plugin_name]'
  
     upstream = 'http://[host_of_application]/[relative_url_root]/'
+
+    # The private_token is optional
+    # It is used to access the application data being coupled to colab
+    # It is recommended to use the provate_token an admin of the application
     private_token = '[plugin_private_token_for_data_import]'
  
     urls = {
-        'include': 'colab.plugins.[plugin_name].urls',
+        'include': '[plugin_module_path].urls',
         'namespace': '[plugin_name]',
-        'prefix': '[application_prefix]',
+        'prefix': '[application_prefix]/', # Exemple: http://site.com/[application_prefix]/
     }
  
     menu_title = '[menu_title_of_html]'
...	...	@@ -73,10 +73,10 @@ Add a new plugin
73	73
74	74	- Create the plugin configuration for the application
75	75
76		- - create file: [plugin_name].py
77		-
78	76	- on folder: /etc/colab/plugins.d/
79	77
	78	+ - create file: [plugin_name].py
	79	+
80	80	Use this template for the plugin configuration file
81	81
82	82	.. code-block:: python
...	...	@@ -87,12 +87,16 @@ Use this template for the plugin configuration file
87	87	name = 'colab.plugins.[plugin_name]'
88	88
89	89	upstream = 'http://[host_of_application]/[relative_url_root]/'
	90	+
	91	+ # The private_token is optional
	92	+ # It is used to access the application data being coupled to colab
	93	+ # It is recommended to use the provate_token an admin of the application
90	94	private_token = '[plugin_private_token_for_data_import]'
91	95
92	96	urls = {
93		- 'include': 'colab.plugins.[plugin_name].urls',
	97	+ 'include': '[plugin_module_path].urls',
94	98	'namespace': '[plugin_name]',
95		- 'prefix': '[application_prefix]',
	99	+ 'prefix': '[application_prefix]/', # Exemple: http://site.com/[application_prefix]/
96	100	}
97	101
98	102	menu_title = '[menu_title_of_html]'
...	...