From 7bfea2a7b7d3d9d095dac88fe528121eee3a0d78 Mon Sep 17 00:00:00 2001 From: Roman Donchenko Date: Wed, 7 Feb 2024 23:04:15 +0200 Subject: [PATCH] Move the description of `HEALTHCHECK_CACHE_KEY` to the correct section It's a setting for the cache backend, but it's documented under "Celery Health Check". Create a "cache" section, and move the documentation there. It's also redundantly documented in `contrib.rst`, despite not being a contrib module. Remove it from there. Fix the typo in the default value while I'm at it. --- docs/contrib.rst | 6 ------ docs/settings.rst | 22 ++++++++++++++++++---- 2 files changed, 18 insertions(+), 10 deletions(-) diff --git a/docs/contrib.rst b/docs/contrib.rst index 7332f155..af649404 100644 --- a/docs/contrib.rst +++ b/docs/contrib.rst @@ -56,9 +56,3 @@ all the time. You may also use both of them. To use these checks add them to `INSTALLED_APPS` in your Django settings module. - -`cache` -------- - -The key `djangohealtcheck_test` will be written to the cache backend to validate that the cache is working. -The name of the key can be customized by setting `HEALTHCHECK_CACHE_KEY` to another value. diff --git a/docs/settings.rst b/docs/settings.rst index f17c1dbc..43f3eb24 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -42,6 +42,24 @@ You can still use any uptime bot that is URL based while enjoying token protecti Do NOT use Django's `SECRET_KEY` setting. This should never be exposed, to any third party. Not even your trusted uptime bot. +`cache` +------- + +The cache backend uses the following setting: + +.. list-table:: + :widths: 25 10 10 55 + :header-rows: 1 + + * - Name + - Type + - Default + - Description + * - `HEALTHCHECK_CACHE_KEY` + - String + - `djangohealthcheck_test` + - Specifies the name of the key to write to and read from to validate that the cache is working. + `psutil` -------- @@ -83,10 +101,6 @@ Using `django.settings` you may exert more fine-grained control over the behavio - Type - Default - Description - * - `HEALTHCHECK_CACHE_KEY` - - String - - `djangohealtcheck_test` - - Specifies the name of the key to write to and read from to validate that the cache is working. * - `HEALTHCHECK_CELERY_QUEUE_TIMEOUT` - Number - `3`