From baf4ff4231505094c7329925179817900d649b32 Mon Sep 17 00:00:00 2001 From: Federico Capoano Date: Fri, 30 Aug 2024 16:36:36 -0400 Subject: [PATCH] [docs] Updated links to docs + other minor fixes [skip ci] --- CHANGES.rst | 38 +++++++++++------------ docs/deploy/freeradius.rst | 4 +-- docs/deploy/freeradius_wpa_enterprise.rst | 6 ++-- docs/developer/index.rst | 4 +-- docs/developer/utils.rst | 2 ++ docs/user/rest-api.rst | 2 ++ openwisp_radius/admin.py | 2 +- openwisp_radius/base/forms.py | 2 +- openwisp_radius/tests/test_admin.py | 2 +- 9 files changed, 33 insertions(+), 29 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 97706ee5..84ea1903 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -59,62 +59,62 @@ Features - Allowed freeradius authorize with email or phone number - Allowed the usage of subnets in `OPENWISP_RADIUS_FREERADIUS_ALLOWED_HOSTS - `_ + `_ - Made the fields containing personal data of users which are exposed in the registration API configurable (allowed, mandatory, disabled) via the `OPENWISP_RADIUS_OPTIONAL_REGISTRATION_FIELDS setting or the admin interface - `_ + `_ - Allow to disable registration API via the `OPENWISP_RADIUS_REGISTRATION_API_ENABLED setting or the admin interface - `_ + `_ - Added `throttling of API requests - `_ + `_ - Added `OPENWISP_RADIUS_API_BASEURL setting - `_ + `_ - Add identity verification feature, configurable via the `OPENWISP_RADIUS_NEEDS_IDENTITY_VERIFICATION or via admin interface - `_ + `_ - Added utilities for implementing `new registration and identity verification methods - `_ + `_ - Added `captive portal mock views - `_ + `_ to ease development and debugging - Add possibility to filter users by registration method in the admin interface - Added SAML registration method to implement `captive portal authentication via Single Sign On (SSO) - `_ + `_ - Added management command and celery task to `delete unverified users - `_ + `_ - Added translations of user facing API responses in Italian, German, Slovenian and Furlan - Added `Convert RADIUS accounting CALLED-STATION-ID feature - `_, + `_, celery task and management command, with the possibility of triggering it on accounting creation (see `OPENWISP_RADIUS_CONVERT_CALLED_STATION_ON_CREATE - `_) + `_) - Added an `equivalent of the FreeRADIUS sqlcounter feature to the REST API - `_ + `_ - Added emission of django signal to FreeRADIUS accounting view: `radius_accounting_success - `_ + `_ - Added possibility to send email to the user an they start a new radius accounting session - Added organization level settings and related admin interface functionality to enable/disable SAML and social login: - `OPENWISP_RADIUS_SAML_REGISTRATION_ENABLED - `_ + `_ - `OPENWISP_RADIUS_SOCIAL_REGISTRATION_ENABLED - `_ + `_ - Added setting to avoid updating username from SAML: `OPENWISP_RADIUS_SAML_UPDATES_PRE_EXISTING_USERNAME - `_ + `_ Changes ~~~~~~~ @@ -152,7 +152,7 @@ Other changes - Moved AccountingView to freeradius endpoints - Relaxed default values for the `SMS token settings - `_ + `_ - Switched to new navigation menu and new OpenWISP theme - Allowed users to sign up to multiple organizations - Update username when phone number is changed if username is equal to the @@ -168,7 +168,7 @@ Other changes - Added validation check to prevent invalid username in batch user creation - Allowed to set the `Password Reset URL setting - `_ + `_ via the admin interface - Added soft limits to celery tasks for background operations - Generalized the implementation of the fallback model fields which allow diff --git a/docs/deploy/freeradius.rst b/docs/deploy/freeradius.rst index b71f4a53..032b3ead 100644 --- a/docs/deploy/freeradius.rst +++ b/docs/deploy/freeradius.rst @@ -381,8 +381,8 @@ ensure the ``authorize`` section of your site as follows contains the .. _radius_debugging: -Debugging ---------- +Debugging & Troubleshooting +--------------------------- In this section we will explain how to debug your freeradius instance. diff --git a/docs/deploy/freeradius_wpa_enterprise.rst b/docs/deploy/freeradius_wpa_enterprise.rst index 54bebf92..812d48e2 100644 --- a/docs/deploy/freeradius_wpa_enterprise.rst +++ b/docs/deploy/freeradius_wpa_enterprise.rst @@ -19,9 +19,9 @@ Prerequisites Execute the steps explained in the following sections of the :doc:`freeradius guide for captive portal authentication `: - - How to install freeradius 3 - - Enable the configured modules - - Configure the REST module +- How to install freeradius 3 +- Enable the configured modules +- Configure the REST module Then proceed with the rest of the document. diff --git a/docs/developer/index.rst b/docs/developer/index.rst index 99915fc9..d441a2cb 100644 --- a/docs/developer/index.rst +++ b/docs/developer/index.rst @@ -12,5 +12,5 @@ Developer Docs Other useful resources: - - :doc:`../user/rest-api` - - :doc:`../user/settings` +- :doc:`../user/rest-api` +- :doc:`../user/settings` diff --git a/docs/developer/utils.rst b/docs/developer/utils.rst index 8fd5de04..b5813c67 100644 --- a/docs/developer/utils.rst +++ b/docs/developer/utils.rst @@ -27,6 +27,8 @@ completes successfully, just before the response is returned. The ``view`` argument can also be used to access the ``request`` object i.e. ``view.request``. +.. _radius_captive_portal_mock_views: + Captive portal mock views ------------------------- diff --git a/docs/user/rest-api.rst b/docs/user/rest-api.rst index 910690ba..5fbe388c 100644 --- a/docs/user/rest-api.rst +++ b/docs/user/rest-api.rst @@ -413,6 +413,8 @@ stop_time Stop time (less or equal to) is_open If stop_time is null ================== ================================ +.. _radius_user_api_endpoints: + User API Endpoints ------------------ diff --git a/openwisp_radius/admin.py b/openwisp_radius/admin.py index 8ea1d41d..c772be66 100644 --- a/openwisp_radius/admin.py +++ b/openwisp_radius/admin.py @@ -371,7 +371,7 @@ class RadiusBatchAdmin(MultitenantAdminMixin, TimeStampedEditableAdmin): 'giving out the credentials.' ), 'documentation_url': ( - 'https://openwisp-radius.readthedocs.io/en/latest/user/importing_users.html' + 'Read https://openwisp.io/docs/dev/radius/user/importing_users.html' ), } diff --git a/openwisp_radius/base/forms.py b/openwisp_radius/base/forms.py index f873adf3..bb9cf194 100644 --- a/openwisp_radius/base/forms.py +++ b/openwisp_radius/base/forms.py @@ -47,7 +47,7 @@ def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) if 'csvfile' in self.fields: docs_link = ( - 'https://openwisp-radius.readthedocs.io/en/latest' + 'Read https://openwisp.io/docs/dev/radius' '/user/importing_users.html' ) help_text = f"Refer to the docs \ diff --git a/openwisp_radius/tests/test_admin.py b/openwisp_radius/tests/test_admin.py index c76a55f0..97896af2 100644 --- a/openwisp_radius/tests/test_admin.py +++ b/openwisp_radius/tests/test_admin.py @@ -407,7 +407,7 @@ def test_radius_batch_csv_help_text(self): add_url = reverse(f'admin:{self.app_label}_radiusbatch_add') response = self.client.get(add_url) docs_link = ( - 'https://openwisp-radius.readthedocs.io/en/latest' + 'Read https://openwisp.io/docs/dev/radius' '/user/importing_users.html' ) self.assertContains(response, docs_link)