diff --git a/beat/web/settings/settings.py b/beat/web/settings/settings.py index 5f86463e36123fd3df8c2328f391bc8071ef16ca..65758b024462142a1a483ecf3610ce1d5dd6298b 100755 --- a/beat/web/settings/settings.py +++ b/beat/web/settings/settings.py @@ -434,4 +434,4 @@ SERIALIZATION_MODULES = {"json": "beat.web.utils.activity_stream_serializer"} # ############################################################################## -DOCUMENTATION_LINK = "https://www.idiap.ch/software/beat/docs/beat/docs/stable/beat.web/doc/user/index.html" +DOCUMENTATION_LINK = "https://www.idiap.ch/software/beat/docs/beat/docs/stable/beat.web/doc/user" diff --git a/beat/web/ui/registration/forms.py b/beat/web/ui/registration/forms.py index cdd08995b8416c42a880fc636a02a4d6474583ad..6bcb3a39168c9d8f430ef9c79e682ec866e38004 100644 --- a/beat/web/ui/registration/forms.py +++ b/beat/web/ui/registration/forms.py @@ -77,7 +77,7 @@ class RegistrationForm(forms.Form): label=_(u'Last name')) email = forms.EmailField(widget=forms.TextInput(attrs=dict(attrs_dict, maxlength=75)), - label=_(u'E-mail address')) + label=_(u'Institutional E-mail address')) password1 = forms.CharField(widget=forms.PasswordInput(attrs=attrs_dict, render_value=False), label=_(u'Password')) password2 = forms.CharField(widget=forms.PasswordInput(attrs=attrs_dict, render_value=False), @@ -350,7 +350,7 @@ class RegistrationSupervisorForm(forms.Form): label=_(u'Last name')) email = forms.EmailField(widget=forms.TextInput(attrs=dict(attrs_dict, maxlength=75)), - label=_(u'E-mail address')) + label=_(u'Institutional E-mail address')) password1 = forms.CharField(widget=forms.PasswordInput(attrs=attrs_dict, render_value=False), label=_(u'Password')) password2 = forms.CharField(widget=forms.PasswordInput(attrs=attrs_dict, render_value=False), diff --git a/beat/web/ui/registration/templates/registration/registration_form.html b/beat/web/ui/registration/templates/registration/registration_form.html index e08b5fb04f6d572be49945ffd037cdfc93d1e80c..3ce2f01695a68077339073da61652004811f08cc 100644 --- a/beat/web/ui/registration/templates/registration/registration_form.html +++ b/beat/web/ui/registration/templates/registration/registration_form.html @@ -115,7 +115,7 @@ {% endfor %} <div class="alert alert-warning" role="alert">Your account needs to be validated by a recognized person on the platform. This recognized - person is known as a <a href="{{url_prefix}}/static/guide/faq.html#what-is-a-supervisor"> supervisor</a>. + person is known as a <a href="{{documentation_link}}/faq.html#what-is-a-supervisor"> supervisor</a>. If you wish to become a supervisor, please follow the <a href="{% url 'contact' %}">contact information</a>. </div> </div> @@ -157,8 +157,8 @@ <div class="alert alert-danger" role="alert">{{ error }}</div> {% endfor %} - <div class="alert alert-warning" role="alert">By requesting a <a href="{{url_prefix}}/static/guide/faq.html#what-is-a-supervisor"> supervisor</a> - account you acknowledge that you hold a position in a research laboratory. In order to become a recognized person on the platform your profile + <div class="alert alert-warning" role="alert">By requesting a <a href="{{documentation_link}}/faq.html#what-is-a-supervisor"> supervisor</a> + account you acknowledge that you hold a permanent position in a research laboratory. In order to become a recognized person on the platform your profile will be checked by the administrators of the platform. </div> diff --git a/beat/web/ui/registration/views.py b/beat/web/ui/registration/views.py index 183f38831b95e94b7e6450849bbb929a4954e366..80f0e741725233dfb56785281162dc4ebf80943a 100644 --- a/beat/web/ui/registration/views.py +++ b/beat/web/ui/registration/views.py @@ -199,6 +199,7 @@ def register(request, success_url=None, context = { 'form': form, 'form_supervisor': form_supervisor, 'supervisor_form_active': supervisor_form_active, + 'documentation_link': settings.DOCUMENTATION_LINK, 'url_prefix':settings.URL_PREFIX } if extra_context is not None: diff --git a/beat/web/ui/templates/ui/bar.html b/beat/web/ui/templates/ui/bar.html index 3b3dcd5149e5db14fea82a6dab1696ed0c1ffa0d..1b67a24e7b4266bb37433fd991f38397a0fab906 100644 --- a/beat/web/ui/templates/ui/bar.html +++ b/beat/web/ui/templates/ui/bar.html @@ -112,7 +112,7 @@ </ul> </div> </li> - <li><p class="navbar-btn"><a class="btn btn-sm btn-default" title="User Guide" href="{{ documentation_link }}" target="_blank"><i class="fa fa-book fa-fw fa-lg"></i> User Guide</a></p></li> + <li><p class="navbar-btn"><a class="btn btn-sm btn-default" title="User Guide" href="{{ documentation_link }}/index.html" target="_blank"><i class="fa fa-book fa-fw fa-lg"></i> User Guide</a></p></li> {% if PREREGISTRATION_ONLY %} <li><p class="navbar-btn"><a class="btn btn-sm btn-primary" title="Pre-register now" href="{% url 'pre-registration' %}"><i class="fa fa-plus fa-fw fa-lg"></i> Sign-up</a></p></li> @@ -138,8 +138,8 @@ </ul> </div> </li> - <li class="visible-xs"><a href="{{ documentation_link }}" target="_blank"><i class="fa fa-book fa-fw"></i> User Guide</a></li> - <li class="hidden-xs"><a class="menu-icon" title="User Guide" data-toggle="tooltip" data-placement="bottom" href="{{ documentation_link }}"><i class="fa fa-book fa-fw"></i></a></li> + <li class="visible-xs"><a href="{{ documentation_link }}/index.html" target="_blank"><i class="fa fa-book fa-fw"></i> User Guide</a></li> + <li class="hidden-xs"><a class="menu-icon" title="User Guide" data-toggle="tooltip" data-placement="bottom" href="{{ documentation_link }}/index.html"><i class="fa fa-book fa-fw"></i></a></li> {% if request.user.is_superuser %} <li class="visible-xs"><a href="{% url 'backend:scheduler' %}"><i class="fa fa-calendar fa-fw"></i> Scheduler</a></li> diff --git a/doc/user/faq.rst b/doc/user/faq.rst index 393bb258e93c111246c44bce5ba23bc3e547403d..be6aca3adc74ccef8fb623a9cb753aea55023f7c 100644 --- a/doc/user/faq.rst +++ b/doc/user/faq.rst @@ -264,7 +264,8 @@ What is a supervisor? A supervisor is a recognized person on the platform. The supervisor is generally a person that holds a senior position in a laboratory/research -institute or company. +institute or company. It is important to note that your email should be +institutional! Why do I need a supervisor to start using the |project| platform? @@ -273,12 +274,14 @@ Why do I need a supervisor to start using the |project| platform? Supervisors ensure you belong to a work group. They are institutionally responsible that you follow the |project| platform terms of use. To successfully register, you'll need to specify the username of a *currently -existing* supervisor on the platform. After you have validated your e-mail -address, a request will be made to such an user in order to confirm your +existing* supervisor on the platform. After you have validated your institutional +e-mail address, a request will be made to such an user in order to confirm your registration. Once the supervisor has confirmed your affiliation, your account becomes active and you can use the platform. Re-activation is required after a period of time (usually every year). +It is important to note that your email should be institutional! + If your supervisor is not registered on the |project| platform, ask them to register, and to make a request to become a supervisor (see text below). Once their account is created, you will then be able to make a supervision request @@ -315,7 +318,7 @@ To become a supervisor, there are two ways. * Sign up on the platform and `register as a supervisor`_. - After you have validated that your email is correct, a request will then be + After you have validated that your institutional email is correct, a request will then be made to the |project| admins in order to validate your account. After checking, that you hold a position in your university/research institute or laboratory, an admin of the platform will accept your request.