Skip to content

Commit 7bfea2a

Browse files
committed
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.
1 parent b0e2c4c commit 7bfea2a

File tree

2 files changed

+18
-10
lines changed

2 files changed

+18
-10
lines changed

docs/contrib.rst

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,3 @@ all the time.
5656

5757
You may also use both of them. To use these checks add them to `INSTALLED_APPS` in your
5858
Django settings module.
59-
60-
`cache`
61-
-------
62-
63-
The key `djangohealtcheck_test` will be written to the cache backend to validate that the cache is working.
64-
The name of the key can be customized by setting `HEALTHCHECK_CACHE_KEY` to another value.

docs/settings.rst

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,24 @@ You can still use any uptime bot that is URL based while enjoying token protecti
4242
Do NOT use Django's `SECRET_KEY` setting. This should never be exposed,
4343
to any third party. Not even your trusted uptime bot.
4444

45+
`cache`
46+
-------
47+
48+
The cache backend uses the following setting:
49+
50+
.. list-table::
51+
:widths: 25 10 10 55
52+
:header-rows: 1
53+
54+
* - Name
55+
- Type
56+
- Default
57+
- Description
58+
* - `HEALTHCHECK_CACHE_KEY`
59+
- String
60+
- `djangohealthcheck_test`
61+
- Specifies the name of the key to write to and read from to validate that the cache is working.
62+
4563
`psutil`
4664
--------
4765

@@ -83,10 +101,6 @@ Using `django.settings` you may exert more fine-grained control over the behavio
83101
- Type
84102
- Default
85103
- Description
86-
* - `HEALTHCHECK_CACHE_KEY`
87-
- String
88-
- `djangohealtcheck_test`
89-
- Specifies the name of the key to write to and read from to validate that the cache is working.
90104
* - `HEALTHCHECK_CELERY_QUEUE_TIMEOUT`
91105
- Number
92106
- `3`

0 commit comments

Comments
 (0)