Skip to content

Commit 795cf2c

Browse files
committed
docs: update links to Django documentation from 3.2 to 4.0
1 parent 3733404 commit 795cf2c

File tree

7 files changed

+35
-35
lines changed

7 files changed

+35
-35
lines changed

benefits/settings.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ def _filter_empty(ls):
122122
# SSL terminates before getting to Django, and NGINX adds this header to indicate
123123
# if the original request was secure or not
124124
#
125-
# See https://docs.djangoproject.com/en/3.2/ref/settings/#secure-proxy-ssl-header
125+
# See https://docs.djangoproject.com/en/4.0/ref/settings/#secure-proxy-ssl-header
126126
if not DEBUG:
127127
SECURE_PROXY_SSL_HEADER = ("HTTP_X_FORWARDED_PROTO", "https")
128128

benefits/urls.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
benefits URL Configuration
33
44
The `urlpatterns` list routes URLs to views. For more information please see:
5-
https://docs.djangoproject.com/en/3.2/topics/http/urls/
5+
https://docs.djangoproject.com/en/4.0/topics/http/urls/
66
"""
77
import logging
88

docs/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The application is accessible to the public at [benefits.calitp.org](https://ben
2020

2121
## Technical details
2222

23-
`benefits` is a [Django 3][django] web application. The application talks to one or more [Eligibility Verification APIs](https://docs.calitp.org/eligibility-api/specification) or authentication providers. These APIs and the application are
23+
`benefits` is a [Django 4][django] web application. The application talks to one or more [Eligibility Verification APIs](https://docs.calitp.org/eligibility-api/specification) or authentication providers. These APIs and the application are
2424
designed for privacy and security of user information:
2525

2626
- The API communicates with signed and encrypted JSON Web Tokens containing only the most necessary of user data for the purpose of eligibility verification
@@ -64,4 +64,4 @@ sequenceDiagram
6464
[interconnections]: deployment/infrastructure/#system-interconnections
6565
[hosting]: deployment/
6666
[littlepay]: https://littlepay.com/
67-
[i18n]: https://docs.djangoproject.com/en/3.2/topics/i18n/
67+
[i18n]: https://docs.djangoproject.com/en/4.0/topics/i18n/

docs/configuration/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ run the app locally. But further configuration is required before many of the in
55

66
There are two primary components of the application configuration include:
77

8-
* Overall app settings in [environment variables][env-vars]
9-
* Content and more specific configurations in [fixtures][fixtures]
8+
- Overall app settings in [environment variables][env-vars]
9+
- Content and more specific configurations in [fixtures][fixtures]
1010

1111
The majority (but not all) of the environment variables are read into [Django settings](#django-settings) during application
1212
startup.
@@ -75,9 +75,9 @@ else:
7575
[benefits-manage]: https://github.com/cal-itp/benefits/blob/dev/manage.py
7676
[benefits-settings]: https://github.com/cal-itp/benefits/blob/dev/benefits/settings.py
7777
[benefits-wsgi]: https://github.com/cal-itp/benefits/blob/dev/benefits/wsgi.py
78-
[django-model]: https://docs.djangoproject.com/en/3.2/topics/db/models/
79-
[django-settings]: https://docs.djangoproject.com/en/3.2/topics/settings/
80-
[django-using-settings]: https://docs.djangoproject.com/en/3.2/topics/settings/#using-settings-in-python-code
78+
[django-model]: https://docs.djangoproject.com/en/4.0/topics/db/models/
79+
[django-settings]: https://docs.djangoproject.com/en/4.0/topics/settings/
80+
[django-using-settings]: https://docs.djangoproject.com/en/4.0/topics/settings/#using-settings-in-python-code
8181
[env-vars]: environment-variables.md
8282
[fixtures]: fixtures.md
8383
[getting-started]: ../getting-started/README.md

docs/configuration/environment-variables.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ If blank or an invalid key, analytics events aren't captured (though may still b
4242

4343
Boolean:
4444

45-
* `True`: activates Django's built-in admin interface for content authoring.
46-
* `False` (default): skips this activation.
45+
- `True`: activates Django's built-in admin interface for content authoring.
46+
- `False` (default): skips this activation.
4747

4848
### `DJANGO_ALLOWED_HOSTS`
4949

@@ -53,7 +53,7 @@ Boolean:
5353

5454
!!! tldr "Django docs"
5555

56-
[Settings: `ALLOWS_HOSTS`](https://docs.djangoproject.com/en/3.2/ref/settings/#allowed-hosts)
56+
[Settings: `ALLOWS_HOSTS`](https://docs.djangoproject.com/en/4.0/ref/settings/#allowed-hosts)
5757

5858
A list of strings representing the host/domain names that this Django site can serve.
5959

@@ -65,13 +65,13 @@ A list of strings representing the host/domain names that this Django site can s
6565

6666
!!! tldr "Django docs"
6767

68-
[Settings: `DEBUG`](https://docs.djangoproject.com/en/3.2/ref/settings/#debug)
68+
[Settings: `DEBUG`](https://docs.djangoproject.com/en/4.0/ref/settings/#debug)
6969

7070
Boolean:
7171

72-
* `True`: the application is launched with debug mode turned on, allows pausing on breakpoints in the code, changes how static
73-
files are served
74-
* `False` (default): the application is launched with debug mode turned off, similar to how it runs in production
72+
- `True`: the application is launched with debug mode turned on, allows pausing on breakpoints in the code, changes how static
73+
files are served
74+
- `False` (default): the application is launched with debug mode turned off, similar to how it runs in production
7575

7676
### `DJANGO_INIT_PATH`
7777

@@ -104,7 +104,7 @@ From inside the container, the app is always listening on port `8000`.
104104

105105
!!! tldr "Django docs"
106106

107-
[Settings: `LOGGING_CONFIG`](https://docs.djangoproject.com/en/3.2/ref/settings/#logging-config)
107+
[Settings: `LOGGING_CONFIG`](https://docs.djangoproject.com/en/4.0/ref/settings/#logging-config)
108108

109109
The log level used in the application's logging configuration.
110110

@@ -118,7 +118,7 @@ By default the application sends logs to `stdout`.
118118

119119
!!! tldr "Django docs"
120120

121-
[Settings: `SECRET_KEY`](https://docs.djangoproject.com/en/3.2/ref/settings/#secret-key)
121+
[Settings: `SECRET_KEY`](https://docs.djangoproject.com/en/4.0/ref/settings/#secret-key)
122122

123123
Django's primary secret, keep this safe!
124124

@@ -130,7 +130,7 @@ Django's primary secret, keep this safe!
130130

131131
!!! tldr "Django docs"
132132

133-
[Settings: `CSRF_TRUSTED_ORIGINS`](https://docs.djangoproject.com/en/3.2/ref/settings/#csrf-trusted-origins)
133+
[Settings: `CSRF_TRUSTED_ORIGINS`](https://docs.djangoproject.com/en/4.0/ref/settings/#csrf-trusted-origins)
134134

135135
Comma-separated list of hosts which are trusted origins for unsafe requests (e.g. POST)
136136

docs/configuration/fixtures.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -24,31 +24,31 @@ environment's configuration database.
2424

2525
The sample data included in the repository fixtures is enough to bootstrap the application with basic functionality:
2626

27-
* Multiple transit agency configurations
28-
* Multiple eligibility verification pathways
29-
* With and without authentication required before eligibility verification
30-
* In concert with the [sample eligibility server][eligibility-server], verification with test user data
27+
- Multiple transit agency configurations
28+
- Multiple eligibility verification pathways
29+
- With and without authentication required before eligibility verification
30+
- In concert with the [sample eligibility server][eligibility-server], verification with test user data
3131

3232
### Not included
3333

3434
Some configuration data is not available with the samples in the repository:
3535

36-
* OAuth configuration to enable authentication (read more about [OAuth configuration](oauth.md))
37-
* Rate Limiting configuration for eligibility
38-
* reCAPTCHA configuration for user-submitted forms
39-
* Payment processor configuration for the enrollment phase
40-
* Amplitude configuration for capturing analytics events
36+
- OAuth configuration to enable authentication (read more about [OAuth configuration](oauth.md))
37+
- Rate Limiting configuration for eligibility
38+
- reCAPTCHA configuration for user-submitted forms
39+
- Payment processor configuration for the enrollment phase
40+
- Amplitude configuration for capturing analytics events
4141

4242
### Sample transit agency: `ABC`
4343

44-
* Presents the user a choice between two different eligibility pathways
45-
* One eligibility verifier requires authentication
46-
* One eligibility verifier does not require authentication
44+
- Presents the user a choice between two different eligibility pathways
45+
- One eligibility verifier requires authentication
46+
- One eligibility verifier does not require authentication
4747

4848
### Sample transit agency: `DefTL`
4949

50-
* Single eligibility pathway, no choice presented to the user
51-
* Eligibility verifier does not require authentication
50+
- Single eligibility pathway, no choice presented to the user
51+
- Eligibility verifier does not require authentication
5252

5353
## Building the configuration database
5454

@@ -73,7 +73,7 @@ more information.
7373

7474
[core-models]: https://github.com/cal-itp/benefits/blob/dev/benefits/core/models.py
7575
[cypress-fixtures]: https://github.com/cal-itp/benefits/tree/dev/tests/cypress/fixtures
76-
[django-data-fixtures]: https://docs.djangoproject.com/en/3.2/howto/initial-data/#providing-data-with-fixtures
76+
[django-data-fixtures]: https://docs.djangoproject.com/en/4.0/howto/initial-data/#providing-data-with-fixtures
7777
[eligibility-server]: https://docs.calitp.org/eligibility-server
7878
[env-django-init]: environment-variables.md#djangoinitpath
7979
[fixtures-sample]: https://github.com/cal-itp/benefits/tree/dev/fixtures

docs/configuration/rate-limit.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,4 @@ Comma-separated list of HTTP Methods for which requests are rate limited.
4444
Number of seconds before additional requests are denied.
4545

4646
[benefits-middleware]: https://github.com/cal-itp/benefits/blob/dev/benefits/core/middleware.py
47-
[django-middleware]: https://docs.djangoproject.com/en/3.2/ref/settings/#std:setting-MIDDLEWARE
47+
[django-middleware]: https://docs.djangoproject.com/en/4.0/ref/settings/#std:setting-MIDDLEWARE

0 commit comments

Comments
 (0)