Skip to content

Commit 4c5f866

Browse files
FlauschbaellchenMarkus Richter
andauthored
Streamline quotes in documentation (#357)
Co-authored-by: Markus Richter <markus.richter@scale.eu>
1 parent cb1898d commit 4c5f866

File tree

3 files changed

+21
-20
lines changed

3 files changed

+21
-20
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,21 +101,21 @@ To use the RabbitMQ healthcheck, please make sure that there is a variable named
101101
rabbit server. For example:
102102

103103
```python
104-
BROKER_URL = amqp://myuser:mypassword@localhost:5672/myvhost
104+
BROKER_URL = "amqp://myuser:mypassword@localhost:5672/myvhost"
105105
```
106106

107107
To use the Redis healthcheck, please make sure that there is a variable named ``REDIS_URL``
108108
on django.conf.settings with the required format to connect to your redis server. For example:
109109

110110
```python
111-
REDIS_URL = redis://localhost:6370
111+
REDIS_URL = "redis://localhost:6370"
112112
```
113113

114114
The cache healthcheck tries to write and read a specific key within the cache backend.
115115
It can be customized by setting `HEALTHCHECK_CACHE_KEY` to another value:
116116

117117
```python
118-
HEALTHCHECK_CACHE_KEY = custom_healthcheck_key
118+
HEALTHCHECK_CACHE_KEY = "custom_healthcheck_key"
119119
```
120120

121121
## Setting up monitoring

docs/contrib.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
contrib
22
=======
33

4-
``psutil``
5-
----------
4+
`psutil`
5+
--------
66

77
Full disks and out-of-memory conditions are common causes of service outages.
88
These situations can be averted by checking disk and memory utilization via the
9-
``psutil`` package:
9+
`psutil` package:
1010

1111
.. code::
1212
1313
pip install psutil
1414
1515
Once that dependency has been installed, make sure that the corresponding Django
16-
app has been added to ``INSTALLED_APPS``:
16+
app has been added to `INSTALLED_APPS`:
1717

1818
.. code:: python
1919
@@ -36,8 +36,8 @@ to disable any of these checks, set its value to ``None``.
3636
'MEMORY_MIN' = 100, # in MB
3737
}
3838
39-
``celery``
40-
----------
39+
`celery`
40+
--------
4141

4242
If you are using Celery you may choose between two different Celery checks.
4343

@@ -57,8 +57,8 @@ all the time.
5757
You may also use both of them. To use these checks add them to `INSTALLED_APPS` in your
5858
Django settings module.
5959

60-
``cache``
61-
---------
60+
`cache`
61+
-------
6262

6363
The key `djangohealtcheck_test` will be written to the cache backend to validate that the cache is working.
6464
The name of the key can be customized by setting `HEALTHCHECK_CACHE_KEY` to another value.

docs/settings.rst

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
Settings
22
========
33

4-
Settings can be configured via the ``HEALTH_CHECK`` dictionary.
4+
Settings can be configured via the `HEALTH_CHECK` dictionary.
55

66
.. data:: WARNINGS_AS_ERRORS
77

88
Treats :class:`ServiceWarning` as errors, meaning they will cause the views
9-
to respond with a 500 status code. Default is ``True``. If set to
10-
``False`` warnings will be displayed in the template on in the JSON
9+
to respond with a 500 status code. Default is `True`. If set to
10+
`False` warnings will be displayed in the template on in the JSON
1111
response but the status code will remain a 200.
1212

1313
Security
@@ -42,13 +42,13 @@ 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-
``psutil``
46-
----------
45+
`psutil`
46+
--------
4747

4848
The following default settings will be used to check for disk and memory
4949
utilization. If you would prefer different thresholds, you can add the dictionary
5050
below to your Django settings file and adjust the values accordingly. If you want
51-
to disable any of these checks, set its value to ``None``.
51+
to disable any of these checks, set its value to `None`.
5252

5353
.. code:: python
5454
@@ -72,6 +72,7 @@ exceeds 90% or available memory drops below 100 MB.
7272

7373
Celery Health Check
7474
-------------------
75+
7576
Using `django.settings` you may exert more fine-grained control over the behavior of the celery health check
7677

7778
.. list-table:: Additional Settings
@@ -84,13 +85,13 @@ Using `django.settings` you may exert more fine-grained control over the behavio
8485
- Description
8586
* - `HEALTHCHECK_CACHE_KEY`
8687
- String
87-
- djangohealtcheck_test
88+
- `djangohealtcheck_test`
8889
- Specifies the name of the key to write to and read from to validate that the cache is working.
8990
* - `HEALTHCHECK_CELERY_QUEUE_TIMEOUT`
9091
- Number
91-
- 3
92+
- `3`
9293
- Specifies the maximum amount of time a task may spend in the queue before being automatically revoked with a `TaskRevokedError`.
9394
* - `HEALTHCHECK_CELERY_RESULT_TIMEOUT`
9495
- Number
95-
- 3
96+
- `3`
9697
- Specifies the maximum total time for a task to complete and return a result, including queue time.

0 commit comments

Comments
 (0)