857b26e5a0
Replace hardcoded Django docs links to intersphinx links
2024-11-05 10:44:39 +00:00
81e6d79c5e
Improve guidelines for writing links in docs
2024-11-05 10:44:38 +00:00
71a735476c
Docs - images/documents title generation - update for CSP compliant examples
...
- Add helpful intro content, insure formatting of Python/JS is consistent
- Avoid inline scripts, instead ensure the example shows external script usage
2024-11-02 10:29:19 +10:00
0913118da4
Replaced Twitter references in the docs with more appropriate alternatives ( #12516 ). Fix #12483
...
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2024-11-01 11:03:54 +00:00
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
fd9b1ca22b
Docs - Update spelling to US customize variants
...
Fixes #12476
2024-10-29 18:47:43 +10:00
a562d4db6a
Docs - Align spelling of 'subpages' to be consistent with rest of docs
2024-10-28 08:34:59 +10:00
d2f476c050
Documentation - Update page titles to align with Style Guide
...
- Use sentence case for headings and titles. (as per the Google Developer Documentation Style Guide)
- Fixes #12466
2024-10-27 15:27:03 +10:00
61fe21af16
Documentation - Add recent third party tutorials ( #12442 )
...
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2024-10-25 13:50:50 +01:00
2d644dd8e2
Documentation - Move tags out from pages model recipes to a standalone advanced topic
2024-10-25 20:30:12 +10:00
f588fcf249
Documentation - Reposition model & panel references
...
- Move model reference to directly under the references section, not the reference/pages section
- Move panel reference to directly under the references section, not the reference/pages section
- Merge panel API with panels reference pages
- Fix confusing heading levels in the page model recipes page
- Fix title in model reference to align with docs style guide
- Adopt US spelling for customize (panels) reference key
2024-10-25 20:30:12 +10:00
d459bdb5dc
Clean up whitespace items in documentation markdown
2024-10-24 11:51:15 +01:00
bbb50459c9
Remove versionadded / versionchanged notes for 6.2
...
However, leave behind notes that mark settings/features that are deprecated but not yet removed, as this would be removing information that isn't in the main body of the text (and moving it out of a versionchanged note would make it harder to find when we come to remove it properly in 7.0).
2024-10-23 16:45:46 +10:00
92567f6203
Document HEIC image support
2024-10-17 23:12:27 +01:00
72292d4d01
Documentation: Configure API to use the DRF's TokenAuthentication ( #12363 )
...
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2024-09-29 15:59:15 +01:00
d526612e4b
Added example for customizing a default accessibility check ( #12267 )
...
Co-authored-by: Albina <51043550+albinazs@users.noreply.github.com>
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2024-09-24 11:00:20 +01:00
8b3540de0d
Simplify Wagtail docs section titles
...
- Avoid additional 'Wagtail' names in the docs titles (inc. contributing)
2024-09-19 10:09:46 +01:00
4e4fac003b
Release note for #12310 / document support for MariaDB
2024-09-12 19:11:22 +01:00
50a1aba134
Clarify UserViewSet customization to avoid confusion with the custom user model's app config
2024-09-11 19:44:36 +01:00
9545193907
Add official hosting documentation
...
- Create a deploy section of the documentation
- Move fly.io deployment from tutorial to it's own page under deploy
- Clean up deployment docs and references throughout documentation
2024-09-03 07:59:20 +10:00
4af8ab528b
Documentation - formatting clean up
2024-08-29 18:32:20 +01:00
1790bdd158
Align recent docs & release notes to US spelling
2024-08-29 18:28:07 +01:00
7582a9932a
Adding updated tutorial link requested by DIVIO.
2024-08-23 15:31:24 +01:00
b757524708
Do not suggest using the custom user model's app config as the custom wagtail.users app config
...
Doing so would mean the "models" module of the app that contains the
custom user model will be used in favour of the models module of the
wagtail.users app, which contains the UserProfile model. As a result,
the UserProfile model becomes mistakenly picked up by the wagtailcore
app, creating a bogus migration when makemigrations is run.
This partially reverts the docs to the version before
449a48d7f9
2024-07-29 17:35:08 +01:00
f7fa20e600
Upgrade Sphinx to 7.3; use newer syntax for no-index directive and --fail-on-warning switch
2024-07-23 10:13:03 +01:00
9adf742580
fixes errors by adding aliases, double backtick, changing indexentry
2024-07-18 23:15:40 +01:00
e02ca6ce62
fixes some of errors by removing directives
2024-07-18 23:13:26 +01:00
62674d3fbb
Add underscore as an alt text antipattern ( #12119 )
2024-07-16 08:53:23 +01:00
f126a4860e
Deprecate user form-related settings
2024-07-10 17:10:36 +02:00
449a48d7f9
Reorganise docs for custom user forms to prefer UserViewSet customisation
...
And make small tweaks to the GroupViewSet docs so the custom apps
examples align.
2024-07-10 17:10:36 +02:00
dc892ac232
Document UserViewSet customisation
2024-07-10 17:10:36 +02:00
03f26187b6
Add alt text validation rule in the accessibility checker ( #11986 )
...
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2024-06-27 09:33:46 +01:00
366a7b7e6f
Add prefers-reduced-motion to accessibility docs ( #12038 )
2024-06-13 14:46:52 +02:00
157a06d3fe
Support SVG icon id attributes with single quotes in the styleguide ( #11903 )
...
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2024-05-30 12:39:03 +01:00
afbafd657d
Remove duplication on performance page for frontend caching proxies ( #11871 )
2024-04-29 19:10:07 +01:00
9dc38076ed
Add missing promote tab to ObjectList permission example ( #11893 )
...
As per https://github.com/wagtail/wagtail/issues/10117#issuecomment-2002393424
2024-04-25 13:45:05 +01:00
c00c2b684f
Allow frontend caching backends to limit which hostnames they respond to
2024-04-24 23:34:33 +01:00
d3d43420aa
Add third party tutorials Q1 2024 ( #11878 )
2024-04-22 12:37:26 +01:00
fd659ae767
Remove versionadded / versionchanged annotations for 6.0
2024-04-22 09:00:36 +07:00
b21b1a1534
Add snug mode release notes
2024-04-18 13:04:25 +01:00
ddb907d274
Add new global CSS variable --w-density-factor
2024-04-18 13:04:25 +01:00
53d6ea4491
Add documentation to support password required settings change
...
PASSWORD_REQUIRED_TEMPLATE -> WAGTAIL_PASSWORD_REQUIRED_TEMPLATE
DOCUMENT_PASSWORD_REQUIRED_TEMPLATE -> WAGTAILDOCS_PASSWORD_REQUIRED_TEMPLATE
2024-04-18 07:03:08 +10:00
e8f4d56583
Support forwards compatible configuration for private pages/collections
...
The new settings introduced in #11582 / #11536 only considered one use case of disabling the shared password option. However, we may want to allow for more complex configuration in the future in this area.
Ensure we can support potential future requirements such as #11640 with a more flexible structure for private pages & collections.
The following settings have been changed from boolean to dictionary values.
WAGTAIL_ALLOW_SHARED_PASSWORD_PAGE -> WAGTAIL_PRIVATE_PAGE_OPTIONS
WAGTAIL_ALLOW_SHARED_PASSWORD_COLLECTION -> WAGTAILDOCS_PRIVATE_COLLECTION_OPTIONS
2024-04-17 15:29:50 +01:00
79bc23788b
Docs - Add additional reference to `wagtail_update_image_renditions` command
...
- We have other references to this command added in 5.2 however we did not include this in the page that goes into detail of Image renditions
- See #8166
2024-03-23 22:56:03 +10:00
77d783b397
Add note about StreamField validation happening on the form
2024-03-14 07:56:15 +10:00
92d1ff5d7a
Remove lesser-used archive formats from WAGTAILDOCS_EXTENSIONS list
2024-03-07 12:19:23 +00:00
00d1d134aa
Mention WAGTAILDOCS_EXTENSIONS in 'integrating into Django' docs
2024-03-07 12:19:22 +00:00
abde315c0b
Update deployment docs to cover XSS risks
2024-03-07 12:19:22 +00:00
b05c50b3f5
Add reference docs for PageListingViewSet
2024-03-07 09:57:11 +00:00
f67b68d8ed
Use double quotes in
...
Co-authored-by: sage <laymonage@gmail.com>
2024-03-07 09:57:10 +00:00
24c984192e
Add documentation for custom page listings via PageListingViewSet
2024-03-07 09:57:10 +00:00
bd065c17cd
Docs - Update and fix broken links
...
Fixes #11635
2024-02-16 17:23:53 +10:00
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
502dd7c723
feature: allow disabling of shared password usage
...
Closes #11536
2024-02-09 08:52:32 +10:00
50b70219d9
Make sure the settings panel is listed in tabbed interface examples
2024-02-08 07:53:28 +10:00
ec37d7e708
Update docs to use new STORAGES setting
2024-02-01 16:41:55 +00:00
c1ad975b3b
Remove versionadded / versionchanged annotations for 5.2
2024-02-01 16:24:12 +00:00
67f3af875c
Update Ordering, wording & help text for private pages/collections
...
- Clarify that the 'password' mode of privacy is a shared password and should not be used for secure content.
- Fixes #11535
2024-01-30 23:18:47 +10:00
c08ca65181
Added documentation for get_upload_to function in AbstractImage and AbstractRendition class
...
- Builds on previous PR #8228
- Fixes #2601
2024-01-30 08:41:17 +10:00
56335de636
Update documentation globally to use US spelling (not UK) + grammar fixes
...
- Transferred all British spellings in the usage guide and advanced topics section to American spellings
2024-01-30 07:30:57 +10:00
f4ce46602f
Update spelling of Customizing Admin Templates and Page Models sections in the docs ( #11544 )
...
* Change all British spelling to American, in the page model section of the docs
* Change all British spelling to American spelling in the Customizing admin templates section of the docs
---------
Co-authored-by: Storm B. Heg <storm@stormbase.digital>
2024-01-27 13:47:12 +01:00
b81f369498
6.0 release - Add versionadded sections & release notes links
2024-01-24 13:54:48 +00:00
996abeae8e
Add initial redirects (contrib) API endpoint
...
Builds on previous PRs #6110 & #8842
2024-01-24 10:42:25 +10:00
4790b44ba1
Move accessibility checker inside the editor ( #11478 ). Fix #10136
2024-01-23 08:15:34 +00:00
b41e196489
Formatting documentation for whitespace fixes
...
Also include actual footnote reference for upgrading patch release note
2024-01-21 19:59:57 +10:00
bbcf1e74ee
Add changelog & a few fixes for #11194
...
Partially reverts commit 7fa335c20d
2024-01-21 18:55:43 +10:00
7fa335c20d
Update Django intersphinx references to new format
2024-01-21 10:09:21 +10:00
33e4e1a136
Update docs on get_language_info tag
...
Prompted by https://stackoverflow.com/q/77646918/1853523 - link to the docs for the tag rather than the function, and include the `{% load i18n %}` line.
2024-01-20 21:48:26 +10:00
e04d540bd1
Add icon--directional class to mirror icons for RTL languages
2024-01-18 11:56:18 +00:00
f0a67975db
Add ability to override a Page's copy form
...
- Documentation added for Customising Copy Form with an auto-incrementing slug example
- Add tests
- Resolves #10147
2024-01-11 08:35:53 +10:00
56135dbb66
Corrected links to Django documentation
...
Apparently you can't use implicit references with url fragments
2024-01-02 06:14:24 +00:00
1b76b8154f
Fix additional ambiguous reference warnings during sphinx build
2024-01-02 06:14:24 +00:00
a69586f61c
Renamed rich_text reference to eliminate ambiguous reference warnings
2024-01-02 06:14:24 +00:00
0880078775
Add some recent third party tutorials (December 2023)
2023-12-08 08:01:09 +10:00
9338ccf974
Updated the performance.md database section
...
Provided more nuance about the recommended database
Closes #10949
2023-11-30 07:44:56 +10:00
ca8a87077b
Add section to testing docs about working with pages
...
- Closes #11244
2023-11-22 08:38:30 +10:00
2e2e8f4452
Minor documentation formatting (Prettier)
2023-11-13 09:53:38 +11:00
8932c67270
Add full set of Documents app features
...
- Added customizing document upload form subsection in documents section
- Added storing and serving subpage
- Added overview section, including RichText and StreamField usage
- Closes #2001
2023-11-13 09:53:16 +11:00
c49ec1bb06
Remove use_json_field parameter from StreamField
2023-11-01 16:52:20 +00:00
c363f6dd27
Remove ModelAdmin
2023-11-01 16:52:20 +00:00
145e33de9d
5.2 release notes - add supporting links and fix typos
2023-10-20 10:13:27 +01:00
26a89cf37d
Updated FieldPanel to TitleFieldPanel in docs
...
- Closes #11078
2023-10-19 22:36:15 +11:00
8002e75775
Documentation - Add initial Stimulus docs
...
- Move extending React to new extending client-side page within advanced topics
- Add general extending JavaScript / client-side overview
- Prepare initial Stimulus usage documentation
- Resolves #10197
- Apply suggestions from code review - Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2023-10-19 07:28:27 +01:00
41dac89e1d
Add srcset_image tag for responsive images
2023-10-17 16:09:06 +01:00
1c4e69dbce
Add better docs & cross-linking for how PanelGroup permission kwarg works
...
Adds more details on how to use the feature added in #8846
2023-10-09 22:50:11 +11:00
15642124b6
API - Allow ordering by multiple fields
...
- Closes #7429
- Builds on original PR #7433 (Jake Howard)
2023-10-09 22:16:31 +11:00
d6888e05e4
Update Format.classnames to be Format.classname
...
- Aligns with the naming convention set from Wagtail 4.2
- Add deprecation warnings if classnames is accessed & unit tests for this
- Update other unit tests to use the naming
2023-10-05 21:10:39 +11:00
f58c896d5a
Add PythonAnywhere deployment tutorial to third party tutorials ( #10958 )
2023-09-28 09:52:04 +01:00
6eda5d5d12
fix typo
2023-09-21 16:45:57 +01:00
cdd6f1800c
Allow subclasses of PagesAPIViewSet override default Page model
...
- Built on original PR #7372 and feedback on that solution
- Add unit tests and documentation
- Fix typo in API documentation for `CustomPagesAPIViewSet`
- Ensure that pk is used (not id) while filtering to prevent assumption that id is pk
2023-09-20 08:13:19 +10:00
dbc130e565
Fix minor typos in the docs
...
"JavasScript" -> "JavaScript"
2023-09-14 06:36:46 +10:00
bf709279d5
Update focal_points.md ( #10878 )
...
corrected the load from {% load wagtailimages %} to {% load wagtailimages_tags %}
2023-09-11 20:13:19 +01:00
65739c6925
Add ModelViewSet.add_to_reference_index to allow opting out of the ReferenceIndex
2023-08-16 11:42:11 +01:00
69724e4e3a
Create preview-aware & page-enhanced cache template tags
...
This can be used in other places, but ensures caches are invalidated
whenever something about a page changes.
- Add a util to get wagtail-specific fragment cache keys
- Don't pollute context when injecting site variable
- Add documentation on wagtail fragment caching
- Define an intelligent cache key for pages
- Allow the components of the cache key to be easily modified
- Note that some manual changes may not create a new cache key
Co-authored-by: Andy Babic <andyjbabic@gmail.com>
Closes #5074
2023-07-20 08:24:09 +10:00
2ed1b33bb8
fix code block typo in streamfield_migrations.md
2023-07-20 07:48:09 +10:00
64f496a2e1
Remove old versionadded / versionchanged notes
2023-07-19 17:53:26 +10:00
ad6fd746b9
Documentation - Add recent third party tutorials
2023-07-18 21:48:59 +10:00
d05c0c1bc1
Update docs to cover Elasticsearch 8 support
2023-07-17 16:18:37 +01:00
3d471edbcf
Clean whitespace formatting in docs
...
- Update formatting with prettier in the documentation
2023-07-17 22:24:54 +10:00
0f97838381
Documentation - revise usage of e.g.
...
- Replace one usage of 'eg' with more suitable alternatives
- As per guidelines https://docs.wagtail.org/en/stable/contributing/general_guidelines.html#latin-phrases-and-abbreviations
2023-07-17 15:13:30 +10:00
Sage Abdullah