303 Commits

Author SHA1 Message Date
Mariusz Felisiak
024e969062 [3.1.x] Changed IRC references to Libera.Chat.
Backport of 66491f08fe86629fa25977bb3dddda06959f65e7 from main.
2021-05-20 12:29:31 +02:00
Carlton Gibson
30b771766b [3.1.x] Corrected typo in advice to new contributors.
Backport of e48e78738e224a056df57b7cb08bd48ac0e54f60 from master
2021-02-04 16:03:26 +01:00
GabbyPrecious
fdeca77215 [3.1.x] Refs #32412 -- Adjusted beginning of Advice for new contributors.
With the goal of guiding folks to the right destination:

* Improved wording of tutorial call-out.
* Added summary of page purpose.
* Added link to Writing code reference doc.

Backport of e733c9ac1746cedc78efabff340379f1c9ee47da from master
2021-02-04 10:39:18 +01:00
Jon Dufresne
915fe98bdc [3.1.x] Updated isort URL to new location.
Backport of 28d998a41c92bdac8eeae6509ecc87ed044b30d0 from master
2020-12-20 11:01:16 +01:00
Nick Pope
1f6e7fb4ab [3.1.x] Changed docs and a code comment to use gender-neutral pronouns.
Follow up to e1b77238171cc96f4451a06fb4682e2378896238.

Backport of 477c800443d091b5f36be9b5f83ce16c85da5879 from master.
2020-11-13 22:29:41 +01:00
Carlton Gibson
848e48c62d [3.1.x] Fixed #29988 -- Updated coding style to allow f-strings.
Thanks to Nick Pope for review.

Backport of 411cc0ae18aa9c64447eed229e65e092d23f80e6 from master
2020-10-15 10:10:49 +02:00
David Smith
12ba61ed17 [3.1.x] Bumped minimum isort version to 5.1.0.
Fixed inner imports per isort 5.
isort 5.0.0 to 5.1.0 was unstable.

Backport of e74b3d724e5ddfef96d1d66bd1c58e7aae26fc85 from master
2020-09-30 09:51:31 +02:00
Mariusz Felisiak
474f65406f [3.1.x] Pinned asgiref to 3.2 series with minimum version to 3.2.10. 2020-07-17 11:08:39 +02:00
Adam Johnson
6ed4a9bdb3 [3.1.x] Refs #31493 -- Replaced var with const/let in documentation JS.
Backport of 2afa61e7d99b2ff2656dc64b6e28db88baf786a4 from master
2020-06-24 12:22:54 +02:00
David Smith
74baa468e0 [3.1.x] Removed redundant pyenchant dependency in spelling check docs.
Backport of 7514852767c4723322f5799a2bd25b7ca263e3b0 from master
2020-06-01 07:08:25 +02:00
Nick Pope
4eb5e4ee4f [3.1.x] Used :envvar: role and .. envvar:: directive in various docs.
Backport of fbdb032de266ba5f82e061ab204f6c622889d563 from master
2020-05-13 09:38:59 +02:00
Nick Pope
345fa40cb5 [3.1.x] Used :mimetype: role in various docs.
Backport of feb91dbda13974f84eac52dccdc0de1ddb636616 from master
2020-05-13 09:38:49 +02:00
Nick Pope
15d76dc2ab [3.1.x] Used :pep: role in various docs.
Backport of a9337b4add01e50ed8ff8d3ef44099a08cba475c from master
2020-05-13 09:38:40 +02:00
Adam Johnson
d17b380653 Refs #30573 -- Rephrased "Of Course" and "Obvious(ly)" in documentation and comments. 2020-05-04 12:10:47 +02:00
Hasan Ramezani
33f7739108 Fixed #31356 -- Changed IRC links to the Freenode webchat. 2020-04-29 20:08:36 +02:00
Jon Dufresne
f48a1990fb
Made compress.py script use the official google-closure-compiler release.
The script previously used the PyPI package closure, which is slightly
out of date and not maintained by Google.

The JavaScript contribution docs and the compress.py script now runs the
google-closure-compiler package in the recommended way. Google's
documentation on usage and installation can be found at:

https://github.com/google/closure-compiler-npm/tree/master/packages/google-closure-compiler#usage

This also makes the usage simpler as the package now runs through npm's
npx utility, which will automatically install google-closure-compiler to
a per-user cache.
2020-04-22 16:19:27 +02:00
Jignesh Kotadiya
7b4bd2a82c
Refs #22463 -- Replaced JSHint with ESLint in contributing docs. 2020-04-20 10:53:00 +02:00
Mariusz Felisiak
cc70a0343e
Fixed term warning on Sphinx 3.0.1+.
"term" role became case sensitive in Sphinx 3.0.1.
2020-04-14 09:32:09 +02:00
Adam Johnson
1cdfe8d912 Prevented (and corrected) single backtick usage in docs. 2020-04-01 14:55:11 +02:00
Takuya Noguchi
c25a8c77d7 Fixed #31241 -- Clarified porting translations of the Django docs to docs.djangoproject.com. 2020-02-12 08:41:48 +01:00
Vibhu Agarwal
6f9ecc23f6
Fixed #31226 -- Fixed typo in docs/internals/contributing/writing-code/submitting-patches.txt. 2020-02-03 20:16:06 +01:00
Vibhu Agarwal
1a09708dcb Fixed #31222 -- Fixed typo in docs/internals/contributing/bugs-and-features.txt. 2020-02-03 11:02:58 +01:00
Mariusz Felisiak
0ac8ac8b0d
Refs #25778 -- Updated some links to HTTPS and new locations. 2020-01-29 09:34:37 +01:00
Jon Dufresne
32166a9f7c
Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
Mads Jensen
ea44d86ed4 Added guidelines for assertIs() usage. 2019-12-30 11:25:18 +01:00
Jon Dufresne
5708327c37 Fixed #23433 -- Deprecated django-admin.py entry point in favor of django-admin.
Unify on the entry point created by setuptools entry_points feature.
2019-12-06 12:11:44 +01:00
Hasan Ramezani
b1d39131eb Fixed typo in internals/contributing/writing-documentation.txt. 2019-12-03 20:11:54 +01:00
Baptiste Mispelon
42df1b178b Refs #31029 -- Added note about :rfc: role in writing documentation docs. 2019-11-27 20:52:28 +01:00
Carlton Gibson
36453526d3
Pinned asgiref version. 2019-11-20 14:57:08 +01:00
Stephen Rauch
4b6db766ba Refs #30183 -- Doc'd dropping support for sqlparse < 0.2.2.
Support for sqlparse < 0.2.2 was broken in
782d85b6dfa191e67c0f1d572641d8236c79174c because is_whitespace property
was added in sqlparse 0.2.2.
2019-11-06 08:45:43 +01:00
André Ericson
54a7b02112 Fixed #30927 -- Simplified an example of test for the deprecation warning with assertWarnsMessage(). 2019-10-30 13:35:36 +01:00
Mariusz Felisiak
2a54ce72f9 Added tblib to the list of test suite dependencies in documentation. 2019-10-23 15:26:04 +02:00
Mariusz Felisiak
e10ebf43e1
Bumped minimum Pillow version to 6.2.0 in test requirements.
Pillow < 6.2.0 is vulnerable to CVE-2019-16865.
2019-10-23 15:07:06 +02:00
Carlton Gibson
adfd920cc5 Moved "Sign the CLA" to the bottom of New Contributor First Steps.
As discussed on the mailing list, step 1 of First Steps shouldn't be
"Find a printer".

https://groups.google.com/d/topic/django-developers/owOqFmxufgs/discussion
2019-10-15 14:10:35 +02:00
Graham Healy
90abdba086 Fixed #30808 -- Added the Django Forum to contributing index. 2019-10-15 08:32:37 +02:00
Kees Hink
5d9cf79baf Fixed #27086 -- Doc'd fix for test suite hang on macOS. 2019-10-09 15:46:44 +02:00
Carlton Gibson
06e087c3de Added note to check Python version in unit tests troubleshooting section.
At DjangoCon US 2019 sprints, a number of contributors hit problems with an outdated Python.
2019-10-09 15:46:44 +02:00
Carlton Gibson
b39c39e82a Corrected section indentation in unit tests contributor docs. 2019-10-09 15:46:44 +02:00
Katherine Michel
f7eb9fb676 Refs #30010 -- Doc'd running tests with django-docker-box. 2019-10-02 13:43:47 +02:00
Tobias Kunze
4a954cfd11 Fixed #30573 -- Rephrased documentation to avoid words that minimise the involved difficulty.
This patch does not remove all occurrences of the words in question.
Rather, I went through all of the occurrences of the words listed
below, and judged if they a) suggested the reader had some kind of
knowledge/experience, and b) if they added anything of value (including
tone of voice, etc). I left most of the words alone. I looked at the
following words:

- simply/simple
- easy/easier/easiest
- obvious
- just
- merely
- straightforward
- ridiculous

Thanks to Carlton Gibson for guidance on how to approach this issue, and
to Tim Bell for providing the idea. But the enormous lion's share of
thanks go to Adam Johnson for his patient and helpful review.
2019-09-06 13:27:46 +02:00
Mariusz Felisiak
053ff7e9e6 Fixed typo in docs/internals/contributing/writing-documentation.txt. 2019-09-05 14:06:46 +02:00
Carlton Gibson
ed2d411aa8 Refs #30573 -- Noted to avoid "simple" & co. in Writing Style guide.
Co-authored-by: Tobias Kunze <r@rixx.de>
2019-09-05 10:13:31 +02:00
Min ho Kim
3c6a4fdb6d Changed example git clone URLs to use HTTPS. 2019-09-04 08:11:22 +02:00
Andrew Godwin
a415ce70be Fixed #30451 -- Added ASGI handler and coroutine-safety.
This adds an ASGI handler, asgi.py file for the default project layout,
a few async utilities and adds async-safety to many parts of Django.
2019-06-20 12:29:43 +02:00
Hasan Ramezani
e2de49ec2e Fixed #28520 -- Added --start-at/--start-after options to runtests.py. 2019-05-31 07:01:12 +02:00
Johannes Hoppe
8d010f3986 Fixed #30220 -- Added support for headless mode in selenium tests. 2019-05-17 08:14:54 +02:00
Jon Dufresne
97d3321e89 Changed tuple choices to list in docs. 2019-05-15 14:31:42 +02:00
Ramiro Morales
25b5eea8cd Fixed #30387 -- Enhanced docs CLI examples in Unit tests and Install Django on Windows.
Follow up to 37c17846ad6b02c6dca72e8087a279cca04a0c27.
2019-04-23 09:32:55 +02:00
Ville Skyttä
34a68c2cbe Fixed typo in docs/internals/contributing/committing-code.txt. 2019-04-21 12:47:33 +02:00
Ramiro Morales
aed89adad5 Fixed #30367 -- Changed "pip install" to "python -m pip install" in docs, comments and hints. 2019-04-18 14:41:15 +02:00