[admin] Added links to netjsonconfig docs

openwisp · Feb 15, 2017 · 6ddc95f · 6ddc95f
1 parent 61fdb1c
commit 6ddc95f
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 2 deletions.
diff --git a/django_netjsonconfig/admin_theme/static/admin/css/openwisp.css b/django_netjsonconfig/admin_theme/static/admin/css/openwisp.css
@@ -88,3 +88,6 @@ a:focus, a:hover {
 #changelist-filter li.selected a{
     color: #df5d43 !important
 }
+
+#netjsonconfig-hint, #netjsonconfig-hint a,
+#container .field-backend a{ color: #df5d43 }
diff --git a/django_netjsonconfig/base/base.py b/django_netjsonconfig/base/base.py
@@ -28,7 +28,8 @@ class BaseConfig(models.Model):
     backend = models.CharField(_('backend'),
                                choices=app_settings.BACKENDS,
                                max_length=128,
-                               help_text=_('Select netjsonconfig backend'))
+                               help_text=_('Select <a href="http://netjsonconfig.openwisp.org/en/'
+                                           'stable/" target="_blank">netjsonconfig</a> backend'))
     config = JSONField(_('configuration'),
                        default=dict,
                        help_text=_('configuration in NetJSON DeviceConfiguration format'),

diff --git a/django_netjsonconfig/static/django-netjsonconfig/css/admin.css b/django_netjsonconfig/static/django-netjsonconfig/css/admin.css
@@ -92,3 +92,7 @@
 .field-vpn, .field-auto_cert{
     display: none;
 }
+#container .help{ margin-top: 2px; font-size: 13px }
+#container .help a,
+#netjsonconfig-hint a{ text-decoration: underline }
+#netjsonconfig-hint{ width: auto }
diff --git a/django_netjsonconfig/static/django-netjsonconfig/js/jsonschemaeditor_widget.js b/django_netjsonconfig/static/django-netjsonconfig/js/jsonschemaeditor_widget.js
@@ -7,7 +7,7 @@
                 id = field.attr('id') + '_jsoneditor',
                 initialField = $('#initial-' + field.attr('id')),
                 container = field.parents('.form-row').eq(0),
-                labelText = container.find('label').text(),
+                labelText = container.find('label:not(#netjsonconfig-hint)').text(),
                 startval = $.isEmptyObject(value) ? null : value,
                 editorContainer = $('#' + id),
                 html, editor, options, wrapper, header,

diff --git a/django_netjsonconfig/widgets.py b/django_netjsonconfig/widgets.py
@@ -26,6 +26,11 @@ def render(self, name, value, attrs={}):
 <input class="button json-editor-btn-edit normal-mode" type="button" value="{0}">
 <input class="button json-editor-btn-edit advanced-mode" type="button" value="{1}">
 <script>django._netjsonconfigSchemaUrl = "{2}";</script>
+<label id="netjsonconfig-hint">
+    Want learn to use the advanced mode? Consult the
+    <a href="http://netjsonconfig.openwisp.org/en/stable/general/basics.html"
+       target="_blank">netjsonconfig documentation</a>.
+</label>
 """
         html = html.format(_('Normal mode'),
                            _('Advanced mode (raw JSON)'),