0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-30 01:46:24 +01:00
Commit Graph

480 Commits

Author SHA1 Message Date
Simon Krull
4f3ec696ff Fix minor typo in the documentation - third party tutorial 2022-04-18 08:26:22 +10:00
luz paz
5c894345b9 Fix various user-facing and non-user-facing typos
- Found via `codespell -q 3 -S *.po,*.js`
2022-04-18 08:18:03 +10:00
Daniel Kirkham
c877bf9886 convert various documentation pages to Markdown
- Removes use of topic:: in docs as this directive is not needed
- resolves #8323
2022-04-18 08:16:27 +10:00
Andy Babic
0c1ecc35f1
Add guidance on rendition prefetching to docs (#8363) 2022-04-16 11:18:23 +01:00
Andy Babic
2d5571f316 Include the new methods in the docs 2022-04-14 12:12:23 +01:00
Matt Westcott
cdeb1cf479
Add use_json_field=True to all StreamField examples (#8359)
This argument should be used on all new StreamFields created under Wagtail 3. It does add some clutter to the examples, but only using it in select cases would create more confusion...
2022-04-14 11:09:19 +01:00
Kevin
0ed4375c3d Fixes incorrect link to Wand docs 2022-04-07 16:20:43 +01:00
LB Johnston
5f4942f9ad documentation - fix broken docs references
- remove 2.16 reference to setting that no longer exists
2022-04-07 12:52:03 +01:00
Caio Jhonny
21202e421e Add missing import django models (#8301)
Django models need to be imported
2022-04-07 12:18:37 +01:00
saurabh
a641057fc2 fixed the errors in deploying.rst and i18n.rst 2022-04-04 06:48:02 +10:00
Saurabh
a70aefe243
fixed punctuation issues and modified text in wagtail documentation. (#8262) 2022-04-01 17:12:57 +01:00
Matt Westcott
b189ab8382 Move wagtail.admin.edit_handlers to wagtail.admin.panels 2022-03-25 10:44:25 -04:00
Karl Hobley
75cc7da38a Move wagtail.core to wagtail 2022-03-17 17:19:59 +00:00
Karl Hobley
0fd99886a2 Move tests to test 2022-03-17 17:19:59 +00:00
p0lygun
fda36c7343 Documentation - convert advanced topics docs to markdown 2022-03-16 20:48:03 +10:00
Nicolas Ferrari
11e7936562
Add alwaysdata among Cloud providers in documentation (#8070)
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2022-03-15 12:29:59 +00:00
LB (Ben Johnston)
e3b6e79a8e
Documentation - migrate form builder docs to markdown (#8007)
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2022-03-10 08:43:49 +00:00
LB (Ben Johnston)
6ed65f14c6
Move Markdown docs to MyST parser. Fix #8074 (#8084) 2022-03-09 11:48:19 +00:00
LB (Ben Johnston)
58a8a31dd6
docs - add third party tutorials Jan/Feb 2022 (#8067) 2022-03-09 09:19:43 +00:00
Matt Westcott
31139e8b24 Remove references to StreamFieldPanel and ChooserPanels from docs 2022-03-02 15:55:25 +00:00
LB Johnston
6ecdc16bd4 remove Hallo references in the documentation 2022-03-02 20:15:33 +10:00
Matt Westcott
8d40a978ef Remove old versionadded / versionchanged notes 2022-02-08 19:00:47 +00:00
LB (Ben Johnston)
b297d521c1
update a few wagtail.io references to wagtail.org (#7905) 2022-02-02 10:39:14 +00:00
Cynthia Kiser
82d9330d77 Added a section to deployment docs about configuring serving of user uploaded files (#7553) 2022-01-21 11:21:53 +00:00
LB (Ben Johnston)
83dd59aef6
documentation - third party tutorials (#7869) 2022-01-21 07:31:00 +00:00
Jake Howard
0a9b23979b Update links to wagtail.io website to point to wagtail.org
This covers only links to the website, not other sites
2022-01-15 20:23:44 +10:00
Matt Westcott
d6d43338ef Drop support for Django <3.2 2022-01-14 14:23:56 +00:00
Matt Westcott
07f1c777e7 Document the bound_blocks property of ListValue 2022-01-07 16:11:45 +00:00
LB (Ben Johnston)
c9aa26e887
Documentation - remove all jQuery usage (#7658) 2021-12-07 15:37:33 +00:00
Dmitrii Faiazov
b314f28f37
Add alias_of field into pages API 2021-12-02 13:36:55 +00:00
JS
40e6e1c803 Docs - Update API configuration example
Code correction - date format was incorrect.
2021-11-30 07:58:13 +10:00
LB Johnston
307d0126a2 add ability to customise the pre-filled document title
- leveraging a custom DOM event provides the ability to update the title before being added to the form
- add documentation
- fixes #7508
- see also #4945
- update image docs for same behaviour to be more readable
2021-10-15 18:25:23 +10:00
LB Johnston
e03c86f3f8 add ability to customise the pre-filled Image title
- leveraging a custom DOM event provides the ability to update the title before being added to the form
- multiple image upload (view) needs to be able to read the title POST data
- add documentation
2021-10-06 19:53:30 +10:00
LB (Ben Johnston)
2eb7232055 Deployment docs - update wagtail getting started 2021-10-05 21:00:48 +10:00
LB Johnston
3e2012373a update documentation & 2.15 release to drop IE11 support
- update browserslist
- fixes #6170
2021-10-04 12:35:58 +01:00
Nick Smith
781c2d14d3 Add How-To instructions for landing-page redirects
This uses both the forms and routable_page contrib modules to redirect
without using a separate landing page.
2021-10-04 14:12:28 +10:00
LB Johnston
8d36168c5c documentation - add third party tutorials from late 2020 to now 2021-08-19 18:53:20 +01:00
Jannis Vajen
fd42d192c9 Fix typo in StructBlock documentation
The StructValue class `LinkValue` is refrerenced as `LinkStructValue` in the Meta class.
2021-08-19 14:48:16 +01:00
Matt Westcott
4e2685f47d Add an 'Extending Wagtail' section to the docs 2021-08-03 16:07:18 +01:00
Karl Hobley
beeb6066ad Changelog / release note for #6843 2021-07-30 11:22:59 +01:00
Karl Hobley
2b2256a31f Implemented background_position_style property on renditions 2021-07-30 11:08:44 +01:00
Karl Hobley
750ecf50b6 Transform focal point 2021-07-30 11:08:44 +01:00
Naomi I. Morduch Toubman
99f05d67cb
Change master to main (in more places) (#7358)
* Update references to branches now named `main`

* Change unnecessary use of `master`

* Change link to be to specific ES docs version

Old release notes should link to contemporaneous docs when possible
2021-07-21 14:09:31 -04:00
Karl Hobley
bea17ac8b6 Add a log action for copy_for_translation operation (#7352)
Currently, when a user copies a page for translation, the 'copy' log action is used.

This adds a more specific 'copy_for_translation' operation to be used instead when the user is translating.
2021-07-21 16:22:55 +01:00
Matt Westcott
bdfa3811d1 Remove outdated versionadded/versionchanged annotations 2021-07-13 17:10:56 +01:00
Nick Smith
1d03c36421 Change some word choices in the docs
This replaces several US English dialectical uses of _regular_ with
British English equivalents _normal_ or _standard_. This is the result
of a search of the docs for the string 'regular', rather than due to any
US English seen in the user interface.

This search also found one use of _regularly_ where _often_ was closer
to the intended meaning, a change which is less about dialect than about
word choice.
2021-07-13 10:51:46 +01:00
Matt Westcott
be857cc5e9 Release note / Upgrade consideration note for #7292 2021-07-12 16:55:21 +01:00
Thomas Kremmel
9b387625ca docs: add facebook and instagram oembed change docs 2021-07-12 15:31:31 +01:00
Coen van der Kamp
3f24beaae6 Add background information on multi site, multi instance and multi tenancy (#7228) 2021-07-09 17:05:28 +01:00
Matt Westcott
9fad84b768 Refactor getChooserConfig / filterEntityData into subclasses of ModalWorkflowSource
This means we're not artificially forcing four different entity types into the same code path, and makes it possible to define new entity types outside of this module.

Also relax the eslint no-unused-vars to allow unused function parameters - having multiple classes following the same interface is a legitimate use of this.
2021-06-28 12:25:29 +01:00
Thibaud Colas
55fe295346 Remove docs for WAGTAILSEARCH_RESULTS_TEMPLATE, WAGTAILSEARCH_RESULTS_TEMPLATE_AJAX
The templates they would override have been removed from our search app, and copies placed in the project template.
2021-06-28 11:23:24 +01:00
Petr Dlouhý
50e4f5151d fix small youtube embed - allow to override max_width/max_height in EmbedBlock 2021-06-25 16:15:09 +01:00
Daniel
431549c427 incorrect field name 2021-06-22 14:34:16 +01:00
Matt Westcott
701fc099a4 Fix mention of documents being served through a Django view
Since Wagtail 2.7, this is no longer true by default when using remote storage - only when `WAGTAILDOCS_SERVE_METHOD` is explicitly set to `serve_view`.
2021-06-22 09:30:33 +01:00
Godswill Melford
212def6aa2 docs: update custom_account_settings.rst
Modify CustomSettingsForm import in hooks.py in user model usage
2021-06-16 10:19:03 +01:00
Thibaud Colas
14b0e807d6
Update guidance on alt text for images in rich text
This shortcoming was fixed and released in Wagtail 2.13
2021-06-11 14:11:55 +01:00
Matt Westcott
004bcf2650
Add documentation for custom JS on StructBlocks (#7164)
* Document the need for data-contentpath with StructBlock.form_template

* Add documentation for custom JS on StructBlocks
2021-05-12 11:52:25 +01:00
Matt Westcott
aa2d10c713 Release note for #6477 2021-05-11 15:05:59 +01:00
Matt Westcott
c1f1c2e95c Copyediting for group view customisation docs 2021-05-11 14:56:33 +01:00
Jan Seifert
9dda314263 Allow GroupViewSet to be customised (#6477) 2021-05-10 14:43:53 +01:00
fabienheureux
6d01ced56b
Fix usage of html syntax instead of html+django (#7138) 2021-05-05 11:08:40 +01:00
Karl Hobley
06be13fda0 Changelog / release note for #7077 2021-04-22 17:29:24 +01:00
Jaap Roes
aafd32b66f
Fix #7007: Add ancestor_of API filter (#7077)
* Fix #7007: Add ancestor_of API filter

* Alter descendant_of_with_type test to find at least one page
2021-04-22 17:23:26 +01:00
Karl Hobley
ab8608a74f Docs for customising account settings 2021-04-20 18:43:22 +01:00
jacobtoppm
7907aff7ff Use CSS variables for comment highlight colours 2021-04-20 18:25:30 +01:00
Coen van der Kamp
b1b69360a3
Add contrib simple translation (#6528) 2021-04-14 08:56:00 +01:00
Storm Heg
1ff679f861
Add wagtail.reorder audit log action
This adds a special audit message for reordering pages.

Previously, reordering pages under the same parent would show the
slighly misleading message that the page was moved to the same parent.
A special page reordered message would be more appropiate in this case.
2021-03-31 18:48:44 +02:00
Matt Westcott
9f084fff6d Add StreamField to title of BoundBlocks page 2021-03-23 18:57:53 +00:00
Matt Westcott
82002df7aa Extend streamfield customisation docs to point to the widget API 2021-03-23 18:57:53 +00:00
Matt Westcott
11d612e6d6 Extend explanation of StructValue 2021-03-23 18:57:53 +00:00
Matt Westcott
c7fd13b20c Split off StreamField customisation docs into a new page 2021-03-23 18:57:53 +00:00
Matt Westcott
37c2326150 Split up StreamField documentation [skip ci] 2021-03-23 18:57:53 +00:00
Jaap Roes
3cc4713316
Replace example YouTube url with a working one (#6923) 2021-03-16 10:41:09 +00:00
Naomi I. Morduch Toubman
664b0489fe
Change master to main (#6830)
* Update references to `master` branch to say `main`

* Update external links

* Update links in old release notes
  Use tagged versions of code rather than current code
2021-03-03 13:33:19 -05:00
Storm Heg
24ef0e62e6 Fix documentation indentation
Fix code block indentation in tutorial.rst

Prevent it from being displayed as a quote.

Fix indentation in pages.rst

Fix indentation in indexing.rst

Fix indentation in searching.rst

Fix indentation in backends.rst

Fix indentation in renditions.rst

Fix indentation in custom_image_model.rst

Fix indentation in feature_detection.rst

Fix indentation in image_serve_view.rst

Fix indentation in custom_document_model.rst

Fix indentation in i18n.rst

Fix indentation in privacy.rst

Fix indentation in page_editing_interface.rst

Fix indentation in rich_text_internals.rst

Fix indentation in extending_hallo.rst

Fix indentation in configuration.rst

Fix indentation in usage.rst

Fix indentation in theory.rst

Fix indentation in model_reference.rst

Fix indentation in queryset_reference.rst

Configure editors to indent .rst files with 2 spaces

In order for the documentation to be styled correctly, the generator
depends on indentation. Too much indentation can result in the content
being wrapped in a quote block, which looks bad.

Fix indentation in sitemaps.rst

Fix indentation in frontendcache.rst

Fix indentation in routablepage.rst

Fix indentation in table_block.rst

Fix routablepage.rst autodocs disppearing

Fix indentation in table_block.rst

Fix indentation in redirects.rst

Fix indentation in table_documentation-modes.rst

Fix indentation in browser_issues.rst

Fix indentation in release_process.rst

Fix indentation of release notes

One more indent fix in the release notes

Fix indentation warnings

Fix warning about undefined label in docs

Error during `make html`:

  wagtail/docs/releases/1.7.rst:25: WARNING: undefined label: jpeg_image_quality
2021-02-26 09:17:00 +00:00
Matt Westcott
720cfebc22 Remove jinja2 from advanced_topics index
a bit of final cleanup from #6779
2021-02-04 20:34:20 +00:00
James Gutu
93abdabd41 moved jinja2 page from Advanced Topics to Reference 2021-02-04 12:12:11 -08:00
John Esther
e317e562ea
Changed the title for Wagtail AMP support (#6775) 2021-02-04 17:28:31 +00:00
Thibaud Colas
75b73b2bf6
Fix typo in inline code formatting (#6783) 2021-02-04 17:26:21 +00:00
Thibaud Colas
30b90a0f65
Improve wagtailforms accessibility guidance (#6740) 2021-01-29 19:45:48 +00:00
Thibaud Colas
bf33842f45
Fix documentation typo 2021-01-27 16:01:06 +00:00
Joshua Marantz
8e79c61564
Implement CSS variables for admin color theming (#6409)
Co-authored-by: JNaftali <jmarantz@thelabnyc.com>
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2021-01-17 02:17:41 +00:00
Vlad Herasymenko
454002fbd7 Include default emed finders in facebook embeds configuration example (#6625)
Facebook and Instagram embeds configuration section should include the default finders for all other providers. It's unclear for someone who just wants to fix his facebook embeds
2021-01-15 21:15:46 +00:00
Matt Westcott
b13641e936 Support custom document models with required fields
Same approach as 4023a90d6e for images - define an UploadedDocument model to hold the uploaded file up to the point where the required metadata has been supplied.
2021-01-15 20:05:08 +00:00
Matt Westcott
c29a92f801 Fix trailing whitespace 2021-01-15 19:44:37 +00:00
Fernando
30ad03d4ca Update S3 CORS documentation for Boto3 (#6668)
Boto3 has been around for a long time now. Adding a Boto-specific parameter in a tutorial is confusing (it was for me) as people are likely to install Boto3 directly and skip Boto. The `AWS_HEADERS` parameter was replaced by the `AWS_S3_OBJECT_PARAMETERS` parameter in Boto3 and the parameter that controls the access control list specifically is the `ACL`.

By the way, are the instructions on line 50 still relevant today?
2021-01-15 19:42:41 +00:00
Thibaud Colas
1914394bc8
Update wagtail forms accessibility considerations to link to Django tickets (#6687) 2021-01-12 16:39:57 +00:00
Brian Oliver
ac88310402
Update third-party tutorials (#6622) 2020-12-09 10:58:50 +00:00
Matt Westcott
2dfb82406a whitespace fix 2020-12-08 12:53:41 +00:00
Matt Westcott
4dc9f81d68 Add {% if page %} around language selector example
As suggested here: https://stackoverflow.com/questions/65065301/wagtail-not-redirecting-500-error-instead-of-404-when-debug-false/65065608?noredirect=1#comment115125518_65065608
2020-12-08 12:53:41 +00:00
Thibaud Colas
06c3c3a24b
Replace image upload in wagtailforms tutorial with latest version. Fix #5284 2020-12-08 10:20:48 +00:00
Cynthia Kiser
28cee081b2 Add custom oEmbed finders for Facebook and Instagram (#6550)
Move code from https://www.codista.com/en/blog/wagtail-instagram-new-oembed-api/ into core

Add custom oembed finder for Facebook

Apply suggestions from @originell's code review

Co-authored-by: Luis Nell <luis.nell@codista.com>

FIXUP More places to change the exception name (and a linter fix)

Extend Instagram/Facebook tests to check HTTP request

Add documentation for omitscript parameter
2020-11-17 15:06:24 +00:00
Thibaud Colas
37e9e1d54d
#6090 Document accessibility considerations (#6272)
Co-authored-by: Coen van der Kamp <coen@fourdigits.nl>
2020-11-06 15:38:00 +00:00
Matt Westcott
6e1e36256a Remove elasticsearch 2 support 2020-11-05 12:04:12 +00:00
Matt Westcott
d56f8ea1c5
More prominent note about wagtail-localize in i18n docs (#6506) 2020-11-02 12:46:16 +00:00
Karl Hobley
6234023f39
Changelog / relase note for internationalisation (#6492)
* Changelog / relase note for internationalisation

* Apply suggestions from code review

Co-authored-by: Matt Westcott <matthew@torchbox.com>
2020-10-23 14:26:44 +01:00
Karl Hobley
bd70ecf318 Tweaks to internationalisation docs 2020-10-23 10:29:22 +01:00
Matt Westcott
7d92e3982f Fix steps for adding translations to an existin snippet
* Fix BootstrapTranslatableMixin to skip TranslatableModel's system check for the missing unique constraint
* Fix incorrect import for BootstrapTranslatableModel and use of `--empty` in final schema migration
* Clarify handling of Meta classes, the fact that you need to run makemigrations for step 1, and what to do for the non-nullable 'locale' prompt
2020-10-22 16:44:54 +01:00
Matt Westcott
5f712b803a fix duplicate target name enabling_internationalisation 2020-10-16 14:15:33 +01:00
Karl Hobley
82dafc7ef8 Add docs for new i18n API filters (#6452) 2020-10-16 13:57:37 +01:00