Sage Abdullah
92714d87e7
Minor tweaks per code review
2024-11-12 10:58:04 +00:00
Sage Abdullah
533481b0f4
Add note about extending section not subject to deprecation policy
2024-11-08 20:09:39 +00:00
Sage Abdullah
991d9bcab5
Update release process documentation
2024-11-08 20:09:39 +00:00
Sage Abdullah
794fa3bcaf
Improve documentation guidelines on writing docstrings and API reference
2024-11-05 12:52:57 +00:00
Sage Abdullah
a81cc7345d
Remove e.g. in documentation guidelines
2024-11-05 12:45:26 +00:00
Sage Abdullah
17ce66ad45
Update outdated Pillow links
2024-11-05 10:44:41 +00:00
Sage Abdullah
da3e0ade37
Use intersphinx to link to MyST-Parser docs
2024-11-05 10:44:41 +00:00
Sage Abdullah
503d1a743a
Replace hardcoded Python docs links with intersphinx
2024-11-05 10:44:40 +00:00
Sage Abdullah
9a5be8f180
Replace more hardcoded Django links with intersphinx in rST docs
...
Some link labels are changed to just the code part, because using Sphinx
roles for code objects (e.g. methods, attributes) would always format the
text as inline code.
It's currently impossible to customize the formatting of a link's text in
rST. See https://stackoverflow.com/questions/4743845
2024-11-05 10:44:39 +00:00
Sage Abdullah
857b26e5a0
Replace hardcoded Django docs links to intersphinx links
2024-11-05 10:44:39 +00:00
Sage Abdullah
9d69863f3c
Use intersphinx to link to Sphinx docs
2024-11-05 10:44:39 +00:00
Sage Abdullah
795ca50dc8
Improve clarity between Markdown/MyST, rST, and Sphinx in docs guidelines
...
Add more emphasis on the divide between when to use Markdown and when to
use rST.
Also improve examples for versionadded and versionchanged directives.
2024-11-05 10:44:39 +00:00
Sage Abdullah
0dc1698857
Do not index autodoc examples
2024-11-05 10:44:39 +00:00
Sage Abdullah
443ccb23a8
Update docs for writing admonitions
...
It's MyST syntax, not rST, so it's OK to use it (sparingly).
Custom admonitions are possible with the `admonition` directive.
2024-11-05 10:44:38 +00:00
Sage Abdullah
81e6d79c5e
Improve guidelines for writing links in docs
2024-11-05 10:44:38 +00:00
Sage Abdullah
dddf9bfd81
Highlight Markdown vs reStructuredText differences for inline styles
2024-11-05 10:24:51 +00:00
Sage Abdullah
121624d5b1
Add syntax highlighting to code block examples
2024-11-05 10:24:51 +00:00
Aayushman Singh
e28beb5b45
Docs - Writing guidelines - Add code example considerations
...
Start a small section to offer some guidance to ensure that code examples are secure, accessible and easier to use.
2024-11-02 10:29:19 +10:00
Sage Abdullah
3802f8bf46
Fix remaining XHTML errors in docs to remove ePub build errors
...
Had to remove the <details> element for the section linking example in
the "Reference links" section.
This is because Sphinx/MyST renders a <section> element for each heading
and closes it when the next heading starts. If we create a heading
inside a <details> element, the <section> element will not be closed
until the next heading starts, which generates invalid HTML.
2024-10-31 07:52:49 +10:00
Matt Westcott
4d31bd0a29
Add clarification on using versionadded / versionchanged directives
2024-10-22 22:13:36 +01:00
Ankit Kumar
329db8e58a
Added missing link to the Code of Conduct in the community guidelines… ( #12432 )
...
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2024-10-20 11:27:21 +01:00
LB Johnston
8b3540de0d
Simplify Wagtail docs section titles
...
- Avoid additional 'Wagtail' names in the docs titles (inc. contributing)
2024-09-19 10:09:46 +01:00
LB Johnston
6bb0c7597f
Docs - Hacktoberfest - Remove reference to the t-shirt
...
There is no longer a t-shirt reward as of 2023
https://hacktoberfest.com/participation/#faq
2024-09-19 08:03:36 +10:00
Matt Westcott
7051363f9f
Change Twitter to X in security.md
2024-08-27 15:32:17 +01:00
Jake Howard
84d9bd6fb6
Mention use of GitHub's security advisories
2024-05-08 12:34:39 +01:00
Jake Howard
37f9ae2ec6
Add note about bug bounties
2024-05-08 12:34:39 +01:00
LB Johnston
6e05134d12
Fix malformed documentation ref developing_using_a_fork
2024-04-19 17:09:50 +10:00
Thibaud Colas
ddb907d274
Add new global CSS variable --w-density-factor
2024-04-18 13:04:25 +01:00
Sage Abdullah
e653a4afbb
Correct LF vs CRLF instruction in Windows development docs ( #11848 )
2024-04-15 13:14:44 +01:00
LB Johnston
42c78a2b17
Fix title of page for UI guidelines
...
- Guidelines is not a proper noun here and should not be capitalised
2024-03-17 21:43:56 +10:00
EK303
bd065c17cd
Docs - Update and fix broken links
...
Fixes #11635
2024-02-16 17:23:53 +10:00
Victoria Poromon
c4f953e90f
Changed all British spellings to American spellings, in the Contributing to wagtail section. ( #11641 )
...
* Changed all British spellings to American spellings, in the Contributing to wagtail section
2024-02-14 08:20:02 +10:00
Buraah
bfa29201c3
Docs - Page names & reference section - Update British spelling to American
...
- Changed all British spellings to American spellings, in the Customizing admin templates section of the docs
- Transferred all British spellings in the usage guide and advanced topics section to American spellings
- Update a series of other pages to use the spelling cutomize in the file name
Implemented all feedbacks on the usage guide and advanced topics section
2024-02-12 08:44:19 +10:00
Matt Westcott
399e09378a
Document the Wagtail 6 pypi classifier
...
Added in https://github.com/pypa/trove-classifiers/pull/169
2024-02-06 17:27:52 +00:00
Sage Abdullah
6a170bb30a
Update Python contributing guidelines
2024-02-01 16:41:55 +00:00
NixAsteri
97fbce30d5
Documentation - Provide contributing dev instructions on using forks
...
- Add details on how to use a fork of the Wagtail code and installing it
- Based on https://stackoverflow.com/a/57407742/8070948
- Closes #10594
2024-02-01 07:08:24 +10:00
LB Johnston
b41e196489
Formatting documentation for whitespace fixes
...
Also include actual footnote reference for upgrading patch release note
2024-01-21 19:59:57 +10:00
LB Johnston
bbcf1e74ee
Add changelog & a few fixes for #11194
...
Partially reverts commit 7fa335c20d
(fixing some issues with the URL updates)
2024-01-21 18:55:43 +10:00
LB Johnston
24725fe681
Add documentation guidelines section for external (Django) links
2024-01-21 10:09:21 +10:00
Neeraj P Yetheendran
7fa335c20d
Update Django intersphinx references to new format
2024-01-21 10:09:21 +10:00
Sage Abdullah
e04d540bd1
Add icon--directional class to mirror icons for RTL languages
2024-01-18 11:56:18 +00:00
Thibaud Colas
be14465c4e
Improve CSS authoring guidelines ( #10049 )
...
Co-authored-by: sage <laymonage@gmail.com>
2024-01-17 07:40:47 +00:00
Thibaud Colas
2706a4c0ce
Add a new "first-time contributor" section at the top of contribution guidelines
2024-01-11 07:43:16 +10:00
Thibaud Colas
75efe99ed2
Reword first contribution guide for readability
2024-01-11 07:43:16 +10:00
nikhilkalburgi
4f24171b3b
docs: update contributing/developing.md guidelines ( #11408 )
...
Fixes #11399
Signed-off-by: nikhilkalburgi <nikhilkalburgi19@gmail.com>
2024-01-02 10:35:33 +00:00
Thibaud Colas
aa8de9f74f
List specific supported Safari versions
...
This is useful because we interpret "Last n" differently for Safari - to only consider major version bumps.
And this will only be updated once a year so it won’t be too onerous to keep up-to-date.
2023-12-19 15:39:49 +00:00
Matt Westcott
4ee7441f20
Remove mention of Google group from security docs
2023-12-15 11:29:45 +00:00
Thibaud Colas
b7d2618d93
Remove Safari 14 support in Wagtail admin – update browserslist and TypeScript ( #11258 )
...
Co-authored-by: Sage Abdullah <sage.abdullah@torchbox.com>
2023-12-12 10:54:41 +00:00
Thibaud Colas
48a62df3df
Update docs now that SVG icons are the only option
2023-11-17 21:04:57 +00:00
Matt Westcott
605c9cf1a6
Drop support for Elasticsearch 5 and 6
2023-11-01 14:57:15 +00:00