From 9e628a167c4cf86067d284cd2469e83385fe3dd9 Mon Sep 17 00:00:00 2001 From: EK303 Date: Wed, 14 Feb 2024 23:58:55 +0600 Subject: [PATCH] Docs - Update and fix broken links Fixes #11635 --- CHANGELOG.txt | 1 + CONTRIBUTORS.md | 1 + .../accessibility_considerations.md | 4 ++-- docs/advanced_topics/i18n.md | 2 +- docs/advanced_topics/third_party_tutorials.md | 14 +++++++------- docs/contributing/documentation_guidelines.md | 2 +- docs/contributing/index.md | 2 +- docs/contributing/issue_tracking.md | 2 +- docs/extending/custom_image_filters.md | 2 +- docs/reference/contrib/frontendcache.md | 4 ++-- docs/reference/jinja2.md | 2 +- docs/releases/1.8.rst | 2 +- docs/releases/6.0.2.md | 1 + docs/topics/images.md | 2 +- 14 files changed, 22 insertions(+), 19 deletions(-) diff --git a/CHANGELOG.txt b/CHANGELOG.txt index bfeffabb4e..6a3a0f0e10 100644 --- a/CHANGELOG.txt +++ b/CHANGELOG.txt @@ -14,6 +14,7 @@ Changelog * Fix: Reinstate styles for customizations of `extra_footer_actions` block in page create/edit templates (LB (Ben) Johnston, Sage Abdullah) * Fix: Prevent crash when loading an empty table block in the editor (Sage Abdullah) * Docs: Update Sphinx theme to `6.3.0` with a fix for the missing favicon (Sage Abdullah) + * Docs: Update broken and incorrect links throughout the documentation (EK303) 6.0.1 (15.02.2024) diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index 07bec5210f..c58067cc20 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -791,6 +791,7 @@ * Osaf AliSayed * mirusu400 * Maikel Martens +* EK303 ## Translators diff --git a/docs/advanced_topics/accessibility_considerations.md b/docs/advanced_topics/accessibility_considerations.md index 91a814b127..8e125e9315 100644 --- a/docs/advanced_topics/accessibility_considerations.md +++ b/docs/advanced_topics/accessibility_considerations.md @@ -211,7 +211,7 @@ def replace_userbar_accessibility_item(request, items): ### wagtail-accessibility -[wagtail-accessibility](https://github.com/neon-jungle/wagtail-accessibility) is a third-party package which adds [tota11y](https://khan.github.io/tota11y/) to Wagtail previews. +[wagtail-accessibility](https://github.com/neon-jungle/wagtail-accessibility) is a third-party package which adds [tota11y](https://blog.khanacademy.org/tota11y-an-accessibility-visualization-toolkit/) to Wagtail previews. This makes it easy for authors to run basic accessibility checks – validating the page’s heading outline, or link text. ### help_text and HelpPanel @@ -220,7 +220,7 @@ Occasional Wagtail users may not be aware of your site’s content guidelines, o ### Readability -Readability is fundamental to accessibility. One of the ways to improve text content is to have a clear target for reading level / reading age, which can be assessed with [wagtail-readinglevel](https://github.com/vixdigital/wagtail-readinglevel) as a score displayed in rich text fields. +Readability is fundamental to accessibility. One of the ways to improve text content is to have a clear target for reading level / reading age, which can be assessed with [wagtail-readinglevel](https://github.com/torchbox-forks/wagtail-readinglevel) as a score displayed in rich text fields. (accessibility_resources)= diff --git a/docs/advanced_topics/i18n.md b/docs/advanced_topics/i18n.md index c4d0024cf8..901574fa20 100644 --- a/docs/advanced_topics/i18n.md +++ b/docs/advanced_topics/i18n.md @@ -353,7 +353,7 @@ Perhaps the most important bit of internationalization-related UI you can add to your site is a selector to allow users to switch between different languages. -If you're not convinced that you need this, have a look at [https://www.w3.org/International/questions/qa-site-conneg#yyyshortcomings](https://www.w3.org/International/questions/qa-site-conneg#yyyshortcomings) for some rationale. +If you're not convinced that you need this, have a look at [https://www.w3.org/International/questions/qa-site-conneg#stickiness](https://www.w3.org/International/questions/qa-site-conneg#stickiness) for some rationale. (i18n_basic_example)= diff --git a/docs/advanced_topics/third_party_tutorials.md b/docs/advanced_topics/third_party_tutorials.md index 7f8ffe8528..acbf3db2bc 100644 --- a/docs/advanced_topics/third_party_tutorials.md +++ b/docs/advanced_topics/third_party_tutorials.md @@ -65,7 +65,7 @@ the latest Wagtail versions. - [Adding Placeholder Text to Wagtail Forms](https://www.coderedcorp.com/blog/adding-placeholder-text-to-wagtail-forms/) (11 February 2022) - [Deploying a Wagtail 2.16 website to Heroku](https://dev.to/kalobtaulien/deploying-a-wagtail-216-website-to-heroku-1iki) (9 February 2022) - [Build an E-Commerce Site with Wagtail CMS, Bootstrap & Django Framework](https://dev.to/paulwababu/build-an-e-commerce-site-with-wagtail-cms-bootstrap-django-framework-4jdb) (7 February 2022) -- [Complex Custom Field Pagination in Django (Wagtail)](https://dev.awhileback.net/hacking-the-django-paginator/) (3 February 2022) +- [Complex Custom Field Pagination in Django (Wagtail)](https://rentfree.media/posts/wagtail/pagination/django/2022-02-03-hacking-the-django-paginator.html) (3 February 2022) - [How to Connect Wagtail and React](https://stackingtabs.medium.com/how-to-connect-wagtail-and-react-7f6d1adf230) (31 January 2022) - [Wagtail: Dynamically Adding Admin Menu Items](https://cynthiakiser.com/blog/2022/01/25/dynamically-adding-menu-items-in-the-wagtail-admin.html) (25 January 2022) - [Headless Wagtail, what are the pain points? (with solutions)](https://tommasoamici.com/blog/headless-wagtail-what-are-the-pain-points) (24 January 2022) @@ -78,7 +78,7 @@ the latest Wagtail versions. - [How To Add an Email Newsletter to Wagtail](https://engineertodeveloper.com/how-to-add-an-email-newsletter-to-wagtail/) (25 November 2021) - [Dealing with UNIQUE Fields on a Multi-lingual Site](https://enzedonline.com/en/tech-blog/dealing-with-unique-fields-on-a-multi-lingual-site/) (6 November 2021) - [General Wagtail Tips & Ticks](https://github.com/spapas/wagtail-faq) (26 October 2021) -- [Branching workflows in Wagtail](https://importthis.tech/wagtail-branching-workflows) (12 October 2021) +- [Branching workflows in Wagtail](https://github.com/engineervix/wagtail-branching-workflows) (12 October 2021) - [Wagtail is the best python CMS in our galaxy - Russian](https://habr.com/ru/post/582898/) (12 October 2021) - [Adding Tasks with a Checklist to Wagtail Workflows](https://dev.to/lb/adding-tasks-with-a-checklist-to-wagtail-workflows-29b8) (22 September 2021) - [How to create a Zen (Focused) mode for the Wagtail CMS admin](https://dev.to/lb/how-to-create-a-zen-focused-mode-for-the-wagtail-cms-admin-3ipk) (5 September 2021) @@ -136,13 +136,13 @@ the latest Wagtail versions. - [Supporting StreamFields, Snippets and Images in a Wagtail GraphQL API](https://wagtail.org/blog/graphql-with-streamfield/) (14 June 2018) - [Wagtail and GraphQL](https://jossingram.wordpress.com/2018/04/19/wagtail-and-graphql/) (19 April 2018) - [Wagtail and Azure storage blob containers](https://jossingram.wordpress.com/2017/11/29/wagtail-and-azure-storage-blob-containers/) (29 November 2017) -- [Building TwilioQuest with Twilio Sync, Django \[incl. Wagtail\], and Vue.js](https://www.twilio.com/blog/2017/11/building-twilioquest-with-twilio-sync-django-and-vue-js.html) (6 November 2017) +- [Building TwilioQuest with Twilio Sync, Django \[incl. Wagtail\], and Vue.js](https://www.twilio.com/en-us/blog/building-twilioquest-with-twilio-sync-django-and-vue-js-html) (6 November 2017) - [Upgrading from Wagtail 1.0 to Wagtail 1.11](https://www.caktusgroup.com/blog/2017/07/19/upgrading-wagtail/) (19 July 2017) - [Wagtail-Multilingual: a simple project to demonstrate how multilingual is implemented](https://github.com/cristovao-alves/Wagtail-Multilingual) (31 January 2017) - [Wagtail: 2 Steps for Adding Pages Outside of the CMS](https://www.caktusgroup.com/blog/2016/02/15/wagtail-2-steps-adding-pages-outside-cms/) (15 February 2016) - [Deploying Wagtail to Heroku](https://wagtail.org/blog/deploying-wagtail-heroku/) (15 July 2015) - [Adding a Twitter Widget for Wagtail's new StreamField](https://jossingram.wordpress.com/2015/04/02/adding-a-twitter-widget-for-wagtails-new-streamfield/) (2 April 2015) -- [Working With Wagtail: Menus](https://www.tivix.com/blog/working-with-wagtail-menus/) (22 January 2015) +- [Working With Wagtail: Menus](https://learnwagtail.com/tutorials/how-to-create-a-custom-wagtail-menu-system/) (22 January 2015) - [Upgrading Wagtail to use Django 1.7 locally using vagrant](https://jossingram.wordpress.com/2014/12/10/upgrading-wagtail-to-use-django-1-7-locally-using-vagrant/) (10 December 2014) - [Wagtail redirect page. Can link to page, URL and document](https://gist.github.com/alej0varas/e7e334643ceab6e65744) (24 September 2014) - [Outputting JSON for a model with properties and db fields in Wagtail/Django](https://jossingram.wordpress.com/2014/09/24/outputing-json-for-a-model-with-properties-and-db-fields-in-wagtaildjango/) (24 September 2014) @@ -153,9 +153,9 @@ the latest Wagtail versions. - [Adding Bread Crumbs to the front end in Wagtail CMS](https://jossingram.wordpress.com/2014/07/01/adding-bread-crumbs-to-the-front-end-in-wagtail-cms/) (1 July 2014) - [Extending hallo.js using Wagtail hooks](https://gist.github.com/jeffrey-hearn/502d0914fa4a930f08ac) (9 July 2014) - [Wagtail notes: custom tabs per page type](https://www.coactivate.org/projects/ejucovy/blog/2014/05/10/wagtail-notes-custom-tabs-per-page-type/) (10 May 2014) -- [Wagtail notes: managing redirects as pages](https://www.coactivate.org/projects/ejucovy/blog/2014/05/10/wagtail-notes-managing-redirects-as-pages/) (10 May 2014) -- [Wagtail notes: dynamic templates per page](https://www.coactivate.org/projects/ejucovy/blog/2014/05/10/wagtail-notes-dynamic-templates-per-page/) (10 May 2014) -- [Wagtail notes: type-constrained PageChooserPanel](https://www.coactivate.org/projects/ejucovy/blog/2014/05/09/wagtail-notes-type-constrained-pagechooserpanel/) (9 May 2014) +- [Wagtail notes: managing redirects as pages](https://www.thirdbearsolutions.com/blog/managing-wagtail-redirects-pages/) (10 May 2014) +- [Wagtail notes: dynamic templates per page](https://www.thirdbearsolutions.com/blog/letting-editors-choose-template-wagtail-page/) (10 May 2014) +- [Wagtail notes: type-constrained PageChooserPanel](https://python.hotexamples.com/examples/wagtail.wagtailadmin.edit_handlers/PageChooserPanel/-/python-pagechooserpanel-class-examples.html) (9 May 2014) You can also find more resources from the community on [Awesome Wagtail](https://github.com/springload/awesome-wagtail). diff --git a/docs/contributing/documentation_guidelines.md b/docs/contributing/documentation_guidelines.md index 45e11730f9..7cd1d6f7b3 100644 --- a/docs/contributing/documentation_guidelines.md +++ b/docs/contributing/documentation_guidelines.md @@ -215,7 +215,7 @@ The reference can be linked to, with an optional label, using the Markdown link -You can read more about other methods of linking to, and creating references in the MyST parser docs section on [Targets and cross-referencing](https://myst-parser.readthedocs.io/en/stable/syntax/syntax.html#targets-and-cross-referencing). +You can read more about other methods of linking to, and creating references in the MyST parser docs section on [Targets and cross-referencing](https://myst-parser.readthedocs.io/en/stable/syntax/cross-referencing.html). #### Intersphinx links (external docs) diff --git a/docs/contributing/index.md b/docs/contributing/index.md index 1c8215f5f2..488d50ac81 100644 --- a/docs/contributing/index.md +++ b/docs/contributing/index.md @@ -57,7 +57,7 @@ We welcome contributions to all aspects of Wagtail. If you would like to improve - Support others with answers to questions on the [Wagtail StackOverflow topic](https://stackoverflow.com/questions/tagged/wagtail) or in Slack `#support`. - Write a review of [Wagtail on G2](https://www.g2.com/products/wagtail/reviews). - Provide some thoughtful feedback on the [Wagtail discussions](https://github.com/wagtail/wagtail/discussions). -- Submit (or write) a tutorial or great package to the [This Week in Wagtail newsletter](https://wagtail.org/this-week-in-wagtail/), [Awesome Wagtail](https://github.com/springload/awesome-wagtail) or [](../advanced_topics/third_party_tutorials). +- Submit (or write) a tutorial or great package to the [This Week in Wagtail newsletter](https://wagtail.org/newsletter/), [Awesome Wagtail](https://github.com/springload/awesome-wagtail) or [](../advanced_topics/third_party_tutorials). ## Developing packages for Wagtail diff --git a/docs/contributing/issue_tracking.md b/docs/contributing/issue_tracking.md index 2cf2829b58..dde43028d9 100644 --- a/docs/contributing/issue_tracking.md +++ b/docs/contributing/issue_tracking.md @@ -6,7 +6,7 @@ We welcome bug reports, feature requests and pull requests through Wagtail's [Gi An issue must always correspond to a specific action with a well-defined completion state: fixing a bug, adding a new feature, updating documentation, or cleaning up code. Open-ended issues where the end result is not immediately clear ("come up with a way of doing translations" or "Add more features to rich text fields.") are better suited to [GitHub discussions](https://github.com/wagtail/wagtail/discussions), so that there can be feedback on clear way to progress the issue and identify when it has been completed through separate issues created from the discussion. -Do not use issues for support queries or other questions ("How do I do X?" - although "Implement a way of doing X" or "Document how to do X" could well be valid issues). These questions should be asked on [Stack Overflow](https://stackoverflow.com/questions/tagged/wagtail) instead. For discussions that do not fit Stack Overflow's question-and-answer format, see the other [Wagtail community support options](https://github.com/wagtail/wagtail#community-support). +Do not use issues for support queries or other questions ("How do I do X?" - although "Implement a way of doing X" or "Document how to do X" could well be valid issues). These questions should be asked on [Stack Overflow](https://stackoverflow.com/questions/tagged/wagtail) instead. For discussions that do not fit Stack Overflow's question-and-answer format, see the other [Wagtail community support options](https://github.com/wagtail/wagtail#-community-support). As soon as a ticket is opened - ideally within one day - a member of the core team will give it an initial classification, by either closing it due to it being invalid or updating it with the relevant labels. When a bug is opened, it will automatically be assigned the [`type:Bug`](https://github.com/wagtail/wagtail/labels/type%3ABug) and [`status:Unconfirmed`](https://github.com/wagtail/wagtail/labels/status%3AUnconfirmed) labels, once confirmed the bug can have the unconfirmed status removed. A member of the team will potentially also add a release milestone to help guide the priority of this issue. Anyone is invited to help Wagtail with reproducing `status:Unconfirmed` bugs and commenting if it is a valid bug or not with additional steps to reproduce if needed. diff --git a/docs/extending/custom_image_filters.md b/docs/extending/custom_image_filters.md index 5179a7998b..0a0160f9b0 100644 --- a/docs/extending/custom_image_filters.md +++ b/docs/extending/custom_image_filters.md @@ -4,7 +4,7 @@ Wagtail comes with [various image operations](image_tag). To add custom image operation, add `register_image_operations` hook to your `wagtail_hooks.py` file. -In this example, the `willow.image` is a Pillow Image instance. If you use another image library, or like to support multiple image libraries, you need to update the filter code accordingly. See the [Willow documentation](https://willow.readthedocs.io/en/latest/index.html) for more information. +In this example, the `willow.image` is a Pillow Image instance. If you use another image library, or like to support multiple image libraries, you need to update the filter code accordingly. See the [Willow documentation](https://willow.wagtail.org/stable/) for more information. ```python from PIL import ImageFilter diff --git a/docs/reference/contrib/frontendcache.md b/docs/reference/contrib/frontendcache.md index 1f283ef874..1c0a421fc9 100644 --- a/docs/reference/contrib/frontendcache.md +++ b/docs/reference/contrib/frontendcache.md @@ -41,7 +41,7 @@ Set `WAGTAILFRONTENDCACHE_LANGUAGES` to a list of languages (typically equal to Finally, make sure you have configured your frontend cache to accept PURGE requests: - [Varnish](https://varnish-cache.org/docs/3.0/tutorial/purging.html) -- [Squid](https://wiki.squid-cache.org/SquidFaq/OperatingSquid#How_can_I_purge_an_object_from_my_cache.3F) +- [Squid](https://wiki.squid-cache.org/SquidFaq/OperatingSquid#how-can-i-purge-an-object-from-my-cache) (frontendcache_cloudflare)= @@ -53,7 +53,7 @@ Add an item into the `WAGTAILFRONTENDCACHE` and set the `BACKEND` parameter to ` This backend can be configured to use an account-wide API key, or an API token with restricted access. -To use an account-wide API key, find the key [as described in the Cloudflare documentation](https://developers.cloudflare.com/api/get-started/keys/#view-your-api-key) and specify `EMAIL` and `API_KEY` parameters. +To use an account-wide API key, find the key [as described in the Cloudflare documentation](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#view-your-global-api-key) and specify `EMAIL` and `API_KEY` parameters. To use a limited API token, [create a token](https://developers.cloudflare.com/api/get-started/create-token/) configured with the 'Zone, Cache Purge' permission and specify the `BEARER_TOKEN` parameter. diff --git a/docs/reference/jinja2.md b/docs/reference/jinja2.md index 5f81903758..009944a7f6 100644 --- a/docs/reference/jinja2.md +++ b/docs/reference/jinja2.md @@ -111,7 +111,7 @@ Or resize an image and retrieve the renditions for more bespoke use: ### `picture()` Resize or convert an image, rendering a `` tag including multiple `source` formats with `srcset` for multiple sizes, and a fallback `` tag. -Browsers will select the [first supported image format](https://web.dev/learn/design/picture-element/#image-formats), and pick a size based on [responsive image rules](https://developer.mozilla.org/en-US/docs/Learn/HTML/Multimedia_and_embedding/Responsive_images). +Browsers will select the [first supported image format](https://web.dev/learn/design/picture-element/#image_formats), and pick a size based on [responsive image rules](https://developer.mozilla.org/en-US/docs/Learn/HTML/Multimedia_and_embedding/Responsive_images). `picture` can render an image in multiple formats: diff --git a/docs/releases/1.8.rst b/docs/releases/1.8.rst index fb80403fd7..5831ffbbb5 100644 --- a/docs/releases/1.8.rst +++ b/docs/releases/1.8.rst @@ -186,7 +186,7 @@ The ``wagtail.contrib.wagtailfrontendcache.backends.CloudflareBackend`` module h }, } -For details of how to obtain the zone identifier, see `the Cloudflare API documentation `_. +For details of how to obtain the zone identifier, see `the Cloudflare API documentation `_. Extra options for the Elasticsearch constructor should be now defined with the new key ``OPTIONS`` of the ``WAGTAILSEARCH_BACKENDS`` setting ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/releases/6.0.2.md b/docs/releases/6.0.2.md index f5d900a945..05d43072a3 100644 --- a/docs/releases/6.0.2.md +++ b/docs/releases/6.0.2.md @@ -26,3 +26,4 @@ depth: 1 ### Documentation * Update Sphinx theme to `6.3.0` with a fix for the missing favicon (Sage Abdullah) + * Update broken and incorrect links throughout the documentation (EK303) diff --git a/docs/topics/images.md b/docs/topics/images.md index 214ab0f7dd..dc4d64aeb9 100644 --- a/docs/topics/images.md +++ b/docs/topics/images.md @@ -366,7 +366,7 @@ For example, to use the `` tag: ``` -And to use the `` tag (based on the [Mountains example](https://amp.dev/documentation/components/amp-img/#example:-specifying-a-fallback-image) from the AMP docs): +And to use the `` tag (based on the [Mountains example](https://amp.dev/documentation/components/amp-img#specify-a-fallback-image) from the AMP docs): ```html+django {% image image width-550 format-webp as webp_image %}