Commit graph

406 commits

Author SHA1 Message Date
Sarah Boyce
481b82802d [5.1.x] Fixed #35908 -- Retired the django-developers and django-users mailing lists.
Co-authored-by: Chaitanya Rahalkar <chaitanyarahalkar@squareup.com>

Backport of 86493307f9 from main.
2025-02-19 12:18:12 +01:00
Baptiste Mispelon
230df91150 [5.1.x] Fixed #36125 -- Switched docs to use chat.djangoproject.com when referencing the Discord server.
Backport of 9a1f18635f from main.
2025-01-22 18:24:02 -03:00
Mariusz Felisiak
db5630763d [5.1.x] Refs #32193 -- Updated python-memcached to pymemcache in contributing guide.
Follow up to 05f3a6186e.
Backport of 337c641abb from main
2025-01-20 22:45:49 +01:00
Sarah Boyce
8d81c4730f [5.1.x] Fixed #35999 -- Removed #django IRC channel references where appropriate.
Some references are replaced with links to the Django Discord server.

Backport of 15e207ce80 from main.
2025-01-08 10:29:52 +01:00
AfiMaameDufie
0c2c33bc87 [5.1.x] Replaced message suggestions from IRC to Discord in contributing docs.
Backport of da2432ccca from main.
2024-11-14 11:38:05 +01:00
Mariusz Felisiak
6f32087a09 [5.1.x] Refs #32365 -- Removed pytz from list of test dependencies in unit test docs.
Follow up to e6f82438d4.

Backport of 46eb256cce from main.
2024-11-11 12:25:51 +01:00
ssanger
08c0c42139 [5.1.x] Fixed #35863 -- Replaced bold text with heading level 3 in new contributors docs.
This improves accessibility for screen reader users, see WCAG SC 1.3.1 Info and Relationships:
https://www.w3.org/WAI/WCAG22/Understanding/info-and-relationships.html

Backport of c4c076223e from main.
2024-11-06 17:05:37 +01:00
Maria Hynes
113c2ff48c [5.1.x] Clarified instructions on how to claim a ticket.
Backport of db5980ddd1 from main.
2024-11-05 17:02:35 +01:00
mbcodes
95067098dd [5.1.x] Improved readability of triage workflow image by increasing its size and color contrast.
Backport of c973d9ee82 from main.
2024-10-25 10:02:28 +02:00
Maryam Yusuf
8ce0039cee [5.1.x] Expanded contributor docs on getting feedback from the wider community.
Backport of 438fc42ac6 from main.
2024-10-16 13:25:43 +02:00
Simon Charette
9a461cae3e [5.1.x] Fixed #35666 -- Documented stacklevel usage and testing, and adjusted test suite accordingly.
Over the years we've had multiple instances of hit and misses when
emitting warnings: either setting the wrong stacklevel or not setting
it at all.

This work adds assertions for the existing warnings that were declaring
the correct stacklevel, but were lacking tests for it.

Backport of 57307bbc7d from main.
2024-08-28 11:47:15 -03:00
Mariusz Felisiak
20bd3f02be [5.1.x] Used :pypi: role in docs where appropriate.
Backport of 304d256674 from main.
2024-08-05 10:36:41 -03:00
Sarah Boyce
d9d77de2f6 [5.1.x] Added contributor guidelines for performance optimizations.
Backport of 2c024c9ac0 from main.
2024-07-25 09:28:15 +02:00
Mariusz Felisiak
e5d2664908 [5.1.x] Updated asgiref dependency for 5.1 release series.
Backport of df35cf578f from main.
2024-07-24 08:25:45 +02:00
Andreu Vallbona
7ad42bc812 [5.1.x] Replaced usage of "patch" with more precise terms in contributing docs.
Backport of 55a2e3136b from main.
2024-07-04 17:55:19 -03:00
Claude Paroz
b4dd76c315 [5.1.x] Migrated setuptools configuration to pyproject.toml.
This branch migrates setuptools configuration from setup.py/setup.cfg to
pyproject.toml. In order to ensure that the generated binary files have
consistent casing (both the tarball and the wheel), setuptools version
is limited to ">=61.0.0,<69.3.0".

Configuration for flake8 was moved to a dedicated .flake8 file since
it cannot be configured via pyproject.toml.

Also, __pycache__ exclusion was removed from MANIFEST and the
extras/Makefile was replaced with a simpler build command.

Co-authored-by: Nick Pope <nick@nickpope.me.uk>

Backport of 4686541691 from main.
2024-06-24 22:31:17 -03:00
Sarah Boyce
39828fa778 Added a high contrast mode to screenshot cases.
Thank you to Sarah Abderemane and Nick Pope for the reviews.
2024-05-02 13:18:58 +02:00
Ryan Cheley
f2c3524959 Fixed #14831 -- Extended template style guide in docs. 2024-03-11 11:05:54 +01:00
Mariusz Felisiak
177e649396
Fixed broken links and redirects in docs. 2024-03-06 08:50:21 +01:00
Koo
aaffbabd58
Fixed typo in docs/internals/contributing/writing-code/coding-style.txt. 2024-02-08 05:57:59 +01:00
Mariusz Felisiak
305757aec1
Applied Black's 2024 stable style.
https://github.com/psf/black/releases/tag/24.1.0
2024-01-26 12:45:07 +01:00
Mark Walker
4eb4ab4122 Reorganized the Contributing to Django docs.
This work follows a comprehensive review conducted during the DjangoCon US 2023
sprints. Changes include:
 - Updated the title of the main page for better alignment with the content.
 - Removed emojis to enhance accessibility and avoid cultural specificity.
 - Improved the layout and navigation of contributing documentation.
 - Unified sections for communication channels and community links.
 - Grouped resources according to the Diátaxis systematic approach.

Co-authored-by: Natalia <124304+nessita@users.noreply.github.com>
Co-authored-by: Daniele Procida <daniele@vurt.org>
2024-01-11 22:25:27 -03:00
Mark Walker
6ab0f8ae52 Improved structure of Contributing Guide start page. 2023-11-30 08:33:29 +01:00
Lance Goyke
a680ac7d77 Restructured writing documentation contributing guide.
This trims and clearly delineates the how to guide from the subsequent
explanation with additional subheadings.

These changes have been discussed with Daniele Procida
at the DjangoCon US 2023 sprints.
2023-10-21 09:44:36 +02:00
David Smith
1611577102 Corrected note about using accents in writing documentation contributing guide. 2023-10-21 09:39:16 +02:00
Sarah Boyce
be56c982c0 Refs #34043 -- Added --screenshots option to runtests.py and selenium tests. 2023-10-18 06:14:40 +02:00
sarahboyce
e083f3082c Refs #34043 -- Clarified how to test UI changes. 2023-10-09 10:45:29 +02:00
Mariusz Felisiak
295467c04a Removed versionadded/changed annotations for 4.2.
This also removes remaining versionadded/changed annotations for older
versions.
2023-09-18 22:12:40 +02:00
Jacob Walls
6c6606aa01 Refs #34233 -- Bumped minimum supported version of docutils to 0.19. 2023-09-04 22:30:45 +02:00
Sulabh Katila
9a9620dda6 Fixed #34768 -- Avoided initializing colorama on non-Windows platforms. 2023-09-01 11:26:29 +02:00
Nick Pope
500e01073a
Fixed #31262 -- Added support for mappings on model fields and ChoiceField's choices. 2023-08-30 22:57:40 -03:00
Mariusz Felisiak
370a021780
Refs #34233 -- Bumped minimum supported version of Selenium to 4.8.0.
This bumps minimum supported versions of selenium to the first release
to support Python 3.10.
2023-06-26 14:22:54 +02:00
Mariusz Felisiak
650ce96782
Refs #34391 -- Updated asgiref dependency for 5.0 release series. 2023-06-23 21:52:04 +02:00
Mariusz Felisiak
06881341d4
Refs #30220 -- Bumped required version of Selenium to 3.8.0.
Follow up to 8d010f3986.
2023-06-13 10:12:52 +02:00
Mohit Singh Sinsniwal
89f10a80d7 Fixed #34579 -- Added Django Forum to contributing guides.
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2023-05-22 20:21:18 +02:00
Mariusz Felisiak
93830abf76
Updated broken links in docs. 2023-05-17 12:13:10 +02:00
nessita
2b11740e1d
Made explicit the location of locally-built HTML docs. 2023-05-11 07:55:45 -03:00
Marc Gibbons
070cbac0db
Restored multiprocessing concurrency on coverage.py settings
* Revert "Reverted "Fixed #33213 -- Doc'd testing code coverage in parallel and used it.""

This reverts commit 78da5ca0c1.

* Restored coverage multiprocess concurrency with threads

Investigating https://github.com/nedbat/coveragepy/issues/1585 revealed
that thread tracing gets disabled when passing
`concurrency = multiprocessing`. Adding `thread` restores it, and
ensures that the `auser()` is reported as covered since the test suite
uses `AsyncToSync` to execute this middleware (which spawns threads).
2023-04-27 17:02:55 -03:00
Claude Paroz
3fe0c609cf
Updated Django Transifex links.
Subdomain was changed on April 3rd and redirects will stop on July 2023.
2023-04-22 16:18:21 +02:00
Sarah Boyce
1611a3af1c
Doc'd RemovedInDjangoXXWarning comments in deprecating a feature guide. 2023-04-19 08:47:27 -03:00
Tim Graham
2c4dc64760 Used extlinks for PyPI links.
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2023-04-17 06:55:32 +02:00
JiriKr
cfe563ffaf Fixed #34446 -- Removed unneeded and incorrect example in coding style docs. 2023-03-30 11:06:52 +02:00
Mariusz Felisiak
78da5ca0c1
Reverted "Fixed #33213 -- Doc'd testing code coverage in parallel and used it."
This reverts commit 69352d85fa.

Test coverage for async methods was no longer calculated with this
change.
2023-03-15 13:05:48 +01:00
django-bot
14459f80ee Fixed #34140 -- Reformatted code blocks in docs with blacken-docs. 2023-03-01 13:03:56 +01:00
Mariusz Felisiak
6015bab80e Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs.
This adds:
- GitHub actions,
- tox configuration,
- pre-commit hook, and
- makefile rules
to run blacken-docs linter.

Co-authored-by: David Smith <smithdc@gmail.com>
2023-03-01 13:02:57 +01:00
Joseph Victor Zammit
ba755ca131 Refs #34140 -- Corrected rst code-block and various formatting issues in docs. 2023-02-28 12:21:37 +01:00
Paolo Melchiorre
69352d85fa
Fixed #33213 -- Doc'd testing code coverage in parallel and used it. 2023-02-11 09:43:26 +01:00
Carlton Gibson
534ac48297 Refs #34140 -- Applied rst code-block to non-Python examples.
Thanks to J.V. Zammit, Paolo Melchiorre, and Mariusz Felisiak for
reviews.
2023-02-10 19:19:13 +01:00
p0lygun
358792486e Fixed #34324 -- Mentioned Discord server in contributing index. 2023-02-10 05:55:45 +01:00
Mariusz Felisiak
3bbe22dafc
Fixed #34233 -- Dropped support for Python 3.8 and 3.9. 2023-01-18 09:46:01 +01:00