Wykres commitów

611 Commity (b75c66ac429bfbeb55f00f0c009447a836c37bfb)

Autor SHA1 Wiadomość Data
LB Johnston 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
rohitsrma 15642124b6 API - Allow ordering by multiple fields
- Closes #7429
- Builds on original PR #7433 (Jake Howard)
2023-10-09 22:16:31 +11:00
LB Johnston 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
Nick Moreton f58c896d5a
Add PythonAnywhere deployment tutorial to third party tutorials (#10958) 2023-09-28 09:52:04 +01:00
Andreas Nüßlein 6eda5d5d12 fix typo 2023-09-21 16:45:57 +01:00
Neeraj P Yetheendran 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
Andy Chosak dbc130e565 Fix minor typos in the docs
"JavasScript" -> "JavaScript"
2023-09-14 06:36:46 +10:00
Hatim Makki Hoho bf709279d5 Update focal_points.md (#10878)
corrected the load from {% load wagtailimages %} to {% load wagtailimages_tags %}
2023-09-11 20:13:19 +01:00
Sage Abdullah 65739c6925
Add ModelViewSet.add_to_reference_index to allow opting out of the ReferenceIndex 2023-08-16 11:42:11 +01:00
Jake Howard 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
Dan Hayden 2ed1b33bb8 fix code block typo in streamfield_migrations.md 2023-07-20 07:48:09 +10:00
Sage Abdullah 64f496a2e1 Remove old versionadded / versionchanged notes 2023-07-19 17:53:26 +10:00
LB Johnston ad6fd746b9 Documentation - Add recent third party tutorials 2023-07-18 21:48:59 +10:00
Matt Westcott d05c0c1bc1 Update docs to cover Elasticsearch 8 support 2023-07-17 16:18:37 +01:00
LB Johnston 3d471edbcf Clean whitespace formatting in docs
- Update formatting with prettier in the documentation
2023-07-17 22:24:54 +10:00
LB Johnston 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
zerolab ce4afcd578 Update documentation for AVIF support
Co-Authored-By: Aman Pandey <74553951+salty-ivy@users.noreply.github.com>
2023-07-14 16:17:53 +01:00
zerolab 6345c8c4c1
Release notes for #10612 2023-07-12 16:59:53 +01:00
Jake Howard 27a203f697
Always cache renditions
This should provide a big performance boost to those who don't set the cache, with minimal extra overhead.
2023-07-12 16:35:06 +01:00
LB Johnston 6491ae49ce Docs - Align on client-side & fix Draftail typos
- Prep for #10197
- Fix a few cases where Draftail was spelt incorrectly
- Align with `client-side` not `clientside` as this is used most commonly
- fix javascript code snippet
2023-07-03 19:18:44 +10:00
Jake Howard ef27a27c1a Docs - Add more details to the performance page & update getting started link
- Link getting started section to elasticsearch backend, not performance page as this is more relevant.
- Mention frontend caching on performance page
- Mention prefetching image renditions on performance page
2023-07-03 08:33:23 +10:00
Jake Howard c2875179b3 Documentation - Clean up and update deployment page
This cleans out some very old, potentially out of scope content, and makes way for the page being much easier to contribute to and extend in future.
Move deploy tutorials to 3rd-party tutorials page
2023-07-01 16:35:57 +10:00
Andy Babic 659c46042e
Add documentation for `Image.get_renditions()` (#9550) 2023-06-29 16:22:16 +01:00
LB Johnston 96a494581c Documentation - clean up last two internal refs to use underscore
- As per https://docs.wagtail.org/en/latest/contributing/documentation_guidelines.html#reference-links - refs should be `lower_snake_case`
2023-06-19 15:18:02 +01:00
Thibaud Colas 268b038ea8 Update documentation for color customisations 2023-06-12 10:55:12 +01:00
Thibaud Colas fe3d0c423f
Add new Sustainability considerations page (#10527)
Co-authored-by: sag᠎e <laymonage@gmail.com>
2023-06-09 12:04:13 +01:00
LB Johnston d5bd828b8e Docs - update Django urls to shorthand method 2023-06-01 16:50:03 +01:00
Etty c5f238f98d Deprecate insert_editor_css in favor of insert_global_admin_css (#10499)
Fixes #10402
2023-06-01 16:28:00 +01:00
LB Johnston aa9e9cddc7 Resolve multiple typos (spelling and grammar)
- Optimized/Customized/Catregorize -> Optimised/Customised/Categorise
- Github -> GitHub (80% were spelt with capital H, this is the way GitHub spells itself)
- GitPod -> Gitpod (most were without the capital P, Gitpod's site does not use capital P)
- Remove duplicate words (to to, the the)
- De-coupled -> decoupled
- implementors -> implementers (all other references used 'site implementers' so just aligning with the common case)
- Fix a/an usage in one case
- Fix one comment usage of ok, replace with OK
2023-05-30 21:07:37 +10:00
LB Johnston 5292f7dc1f Docs - fix whitespace formatting (Prettier) 2023-05-30 07:25:21 +10:00
Sage Abdullah f2accc89e3 Add link to snippets icon customisation from icons documentation 2023-05-24 11:06:00 +01:00
Krzysztof Jeziorny 0552af3c30 Update third_party_tutorials.md
The article "10 (recommended) Wagtail Best Practices" is gone and not to find on the origin website.
2023-05-03 10:34:03 +01:00
Matt Westcott 4a47bc611b Remove old versionadded / versionchanged notes 2023-04-21 13:47:10 +01:00
LB Johnston b6392eab05 Docs - Add recent third party tutorials 2023-04-20 18:12:47 +01:00
Matt Westcott 85c9b6689f Ensure that models can still be registered with ReferenceIndex.register_model after the initial set of signals has been connected 2023-04-20 11:21:43 +01:00
Daniel Kirkham 659251b8a7 Added Documentation 2023-04-20 11:21:03 +01:00
sag᠎e ed36b5b9b6
Improve customisability of the accessibility checker configuration. Fix #10137 (#10333)
* Extract userbar BaseItem.get_context_data()
* Extract Axe config into smaller attributes and methods for easier overrides
* Add TypeScript interface for WagtailAxeConfiguration
* Improve typings for userbar.ts
* Separate Axe `runOnly` and `rules` options
* Pass request object to all axe configuration methods
* Remove Axe runOnly option if it's falsy
* Add docs for customising the accessibility checker
* Use lists for Axe include and exclude selectors
* Parse JSON script when testing accessibility checker config
* Add tests for customising accessibility checker configuration

Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2023-04-20 07:46:56 +01:00
Thibaud Colas 567b999548 Set up new color design tokens for light and dark themes 2023-04-19 13:38:23 +01:00
Sage Abdullah 64ea6dd8b8 Fix missing newline in editing interface customisation docs
Regression in 2abd7916af
2023-04-18 19:14:02 +10:00
Sage Abdullah eb49f3cdf0 Add docs for FieldPanel's icon parameter 2023-04-18 02:49:04 +01:00
Sage Abdullah b017157818 Fix extraneous period typo in page editing interface docs 2023-04-18 02:49:04 +01:00
Thibaud Colas 93732690a3 Update icon visuals to FontAwesome 6, with deprecation warnings for removed icons 2023-04-14 08:38:01 +01:00
Joshua Munn 196ed4162d Add SVG docs 2023-03-30 10:19:43 +01:00
Thibaud Colas d856e702e1 Update documentation on icons management, with available icons 2023-03-28 16:13:35 +01:00
Andy Babic f680f188f3 Add useful properties to Locale
- Update get_display_name() to always return a string
- Add documentation and unit tests
2023-03-21 08:02:40 +10:00
LB Johnston 65f2eaa4d2 Documentation - Clean up minor formatting issues 2023-03-21 08:02:25 +10:00
Satvik Vashisht 4ee60b5d47 Adopt the pageurl template tag over `page.url` where possible
- Fixes #10125
- So that determining page URL is more performant - see https://docs.wagtail.org/en/stable/advanced_topics/performance.html#page-urls
2023-03-18 07:35:27 +10:00
Lovelyfin00 2519dc84e8 adding the introduction to stimulus webinar video link to docs 2023-03-08 06:35:59 +10:00
Matt Westcott a07fe20ceb Add documentation for customising StreamField validation 2023-03-01 12:07:13 +01:00
Matt Westcott dc2afe89b9 Specify that h1, h5, h6 are disabled in rich text by default
Fixes #10124
2023-02-22 08:48:02 +00:00
Kenny Wolf f50f04e129
Docs - Remove deprecated Settings Tab from documentation (#9813)
Since Wagtail 4.1 the Settings Tab and the corresponding scheduling of pages has been moved to the Status side panels. As mentioned in the release notes of Wagtail 4.1: [See here](https://docs.wagtail.org/en/stable/releases/4.1.html#new-ui-for-scheduled-publishing).

In the documentation section for customising the edit interface, this snippet is still available. When implemented, there is no effect and no error is shown.

Therefore this line is obsolete and only the two tabs 'Content' and 'Promote' should be available.

Co-authored-by: Julian Bigler <disperate@users.noreply.github.com>
2023-02-19 14:32:13 +10:00
Thibaud Colas e3d0cc8099
Iterate on accessibility checker docs (#10064) 2023-02-13 14:27:25 +00:00
Albina 546a552ac2
Add more Axe rules to the accessibility checker (#10011)
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2023-02-13 13:01:34 +00:00
LB (Ben Johnston) 8aa892bf0f
Add recent third party tutorials (Feb 2023) (#10059) 2023-02-10 23:02:02 -05:00
LB Johnston 93d3652a15 Documentation - fix whitespace issues 2023-02-11 08:29:13 +10:00
Matt Westcott 83cbd2fffa Add missing changed=False initialisation 2023-02-10 13:20:34 +00:00
Matt Westcott 635db6d850 Update richtext to streamfield migration snippet
Perform the data migration while it's still a rich text field, to avoid the need for `use_json_field=False`. Also work around the unavailability of `page.revisions` on frozen ORM models (which has been absent since 4.0, since it's now a property on RevisionMixin rather than a true relation).
2023-02-10 13:20:33 +00:00
Coen van der Kamp 619f395980 Add new "Icons" page for icons customisation and reuse across the admin interface (#6028)
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2023-02-10 07:22:45 +00:00
Matt Westcott 18a574b520 Remove old versionadded / versionchanged directives from docs 2023-02-08 14:25:09 +00:00
Albina d093a78cec
Accessibility checker documentation (#10029) 2023-02-06 12:38:18 +00:00
Matt Westcott b735700ddf Release note for #9935 in 4.1.x 2023-02-03 17:54:55 +00:00
Daniel Kirkham 161e95f4cc Add Reference Index documentation 2023-02-03 17:36:30 +00:00
Thibaud Colas 7339f6c3d1
Update guide.wagtail.org links to use most up-to-date URL and page name, with "latest" redirect 2023-02-03 11:13:15 +00:00
LB Johnston 9e016c17b8 Documentation - whitespace formatting fixes
- Includes small fix for #9969 missing space
2023-01-28 06:59:01 +10:00
Matt Westcott 04df875d17 Fix assertCanCreate to publish by default
Fixes #9939

Also remove the mentions of redirects from the documentation - the fact that the method has to check for a different redirect URL is an internal implementation detail, and not relevant to what the assertion is intending to test (namely that a page is successfully created).
2023-01-25 08:14:15 +10:00
4the4ryushin 529d2feb49 Add docs example for how to configure API renderer_classes
- Update docs/advanced_topics/api/v2/configuration.md
- Fixes #6066
- Fix up spelling of customise (UK English not US)
2023-01-19 20:43:45 +10:00
Sandil Ranasinghe 3ed84b36da make streamfield migration names from operations
- `operation_name_fragment` property added to operations
- `migration_name_fragment` property added to MigrateStreamData
- added tests, docs updated
- BaseBlockOperation inherits from `abc.ABC`
2023-01-18 19:29:56 +00:00
Jhonatan Lopes 7a6feb188f Link django docs to stable version 2023-01-11 20:18:04 +10:00
Jhonatan Lopes a045bc38c4 Change Facebook company name to Meta 2023-01-11 20:18:04 +10:00
Jhonatan Lopes 68900b069a Change "note that.." to a note 2023-01-11 20:18:04 +10:00
Jhonatan Lopes 532f17bad7 Remove broken Divio bakery demo 2023-01-11 20:18:04 +10:00
Albina a37c4bab3d
Re-implement design system colors so HSL values exactly match the desired RGB. Fix #9571 (#9856)
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>

Fixes https://github.com/wagtail/wagtail/issues/9571
2023-01-10 08:31:51 +00:00
LB Johnston edb86a7e8f Documentation - Fix missing links / images
Most of these are no longer applicable due to the introduction of Wagtail guide, where possible the new guide links are used now
- Re-add missing docs image for extending Draftail
- There is no Guide page (yet) for Inserting videos or images so those links have been removed
- Fix some additional reference issues where the page name and reference were causing issues
2023-01-05 12:08:27 +00:00
Jake Howard 0f209ee848 Add `{% fullpageurl %}` for resolving absolute URLs to pages 2023-01-04 16:13:56 +00:00
LB Johnston 8678cad90b Update third party tutorials for December 2022 2023-01-03 10:13:51 +00:00
LB Johnston da90061ca8 Docs - formatting - clean up whitespace 2022-12-11 18:43:50 +10:00
Damascene 5d78e03084 Docs - Update PASSWORD_REQUIRED_TEMPLATE example
- Add messaging for signed in users that do not have permission for a page
2022-12-11 15:33:30 +10:00
Matt Westcott f635038e13 Release note for StreamField data migration helpers (#9694) 2022-12-09 16:40:07 +00:00
Joshua Munn e84cdc4e2c Add wagtail-streamfield-migration-toolkit docs
- Move RichText -> StreamField migration guide into
  advanced/streamfield_migrations.md
2022-12-09 16:40:07 +00:00
LB Johnston 3d484e133d Update icon template to allow `classname`
- Preserve the existing `class_name` behaviour in most other cases
- Update only docs reference to use `classname`
- Relates to #6107 & #6028
2022-12-09 20:13:33 +10:00
Sævar Öfjörð Magnússon 629b8e7a55 Add ability to easily use Form Page fields in API
Improve documentation. Adding information about how to retrieve form fields from the API.
Include the API fields on the form field model
2022-11-18 06:58:16 +10:00
4the4ryushin 35a2f2cb7e Add purge_embeds management command
- Fixes #1267
- Caching OEmbed markup prevents markup changes for existing embeds so allow an easy way to clear these if needed
2022-11-11 08:00:50 +10:00
Jake Howard 66421dac13
Performance page cleanup (#9362)
* Clean up the performance page structure

Many of the sections mentioned here will improve performance for much more than just the editor experience.

* Link to Django's performance page
2022-10-28 10:33:00 -04:00
Jake Howard c6afb0069d Performance docs - Mention the importance of passing `request` and `current_site` to `get_url`
- Co-authored-by: Andy Babic <ababic@users.noreply.github.com>
2022-10-28 06:24:38 +10:00
DokuaAsiedu af9f7ecbb3 Add docs & unit tests for assertCanCreate with publish (#9458)
- Builds on #9458
2022-10-27 07:54:32 +10:00
Ogunbanjo oluwadamilare 1428333af8 Documentation - added contributing translations guide
- Fixes #7115
2022-10-26 08:29:29 +10:00
Toyibat Adele 33c381f95c
Corrected typos and added punctuation marks to sentences missing them. (#9422)
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2022-10-25 07:26:59 +01:00
Damilola Oladele 64e3595c6e
Grammatical adjustments of advanced topic `Documents` (#9426) 2022-10-21 00:32:50 +01:00
Damilola Oladele de28bca258
Grammatical adjustments of advanced topic `images`, to resolve issue #9407 (#9408)
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2022-10-21 00:30:13 +01:00
Jake Howard 55f42d29c8 Mention using the `image_url` tag for increased performance on image URLs 2022-10-18 08:16:02 +10:00
Andy Babic c94ba56128 Documentation - update testing page with WagtailPageTestCase
- Docs for #9294
2022-10-18 08:00:20 +10:00
LB (Ben Johnston) 18371e2113
Documentation - adopt consistent `sh` console code snippets (#9321) 2022-10-13 07:25:19 +01:00
LB (Ben Johnston) cd88d1191d
Add recent third party tutorials (October 2022) (#9307) 2022-10-13 07:19:36 +01:00
LB Johnston 2e8709e0d6 Documentation - update dead/redirected links 2022-10-11 20:44:08 +10:00
Haydn Greatnews 02b2b7c9f2 Fix some casing code in examples in API configuration docs 2022-10-01 17:56:08 +10:00
Storm Heg 6a8ce3161e Fix code style of example in Wagtail API docs
Example code should be compliant with PEP-8.
2022-09-19 21:49:01 +10:00
Christophe Bastin 5dad39fb57 docs: APIField naming (#9173) 2022-09-09 13:47:46 +01:00
Jake Howard 5108b5f82a Add ability to set default configurable attributes to image tags
- Allow users to override the default attributes given to an image
- Update tests to account for new tags
- Add documentation for custom image attributes
- Recommend that loading=lazy & decoding=async be considered for performance in front-end sites
2022-08-25 18:20:45 +10:00
Mehrdad Moradizadeh b92dcc11b4
Documentation - add WAGTAILADMIN_RICH_TEXT_EDITORS reference (#9079)
- Mention settings on admin customisation page
- fixes #9070
2022-08-25 06:31:04 +10:00
LB Johnston 666cc5e8e5 fix up legacy release note refs & use consistent format
- fix some broken refs that were lost in the migration to markdown files
- use lower_snake_case for all internal refs (most follow this convention)
- release process sub-section in docs should be named release schedule instead
2022-08-16 12:42:42 +01:00