Browse Source

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
LB Johnston 2 years ago
parent
commit
edb86a7e8f

BIN
docs/_static/images/draftail_entity_stock_source.gif


+ 1 - 1
docs/advanced_topics/add_to_django_project.md

@@ -96,7 +96,7 @@ Wagtail requires several Django app modules, third-party apps, and defines sever
  The Wagtail image content type.
 
 **`wagtail.embeds`**  
- Module governing oEmbed and Embedly content in Wagtail rich text fields. See [](inserting_videos).
+ Module governing oEmbed and Embedly content in Wagtail rich text fields.
 
 **`wagtail.search`**  
  Search framework for Page content. See [](wagtailsearch).

+ 2 - 2
docs/advanced_topics/deploying.md

@@ -3,7 +3,7 @@
 ## On your server
 
 Wagtail is straightforward to deploy on modern Linux-based distributions, and should run with any of the combinations detailed in Django's [deployment documentation](django:howto/deployment/index).
-See the section on [performance](performance) for the non-Python services we recommend.
+See the section on [performance](performance_overview) for the non-Python services we recommend.
 
 ## On Divio Cloud
 
@@ -70,7 +70,7 @@ If you would like to serve your images from a separate asset server or CDN, you
 Document serving is controlled by the [WAGTAILDOCS_SERVE_METHOD](wagtaildocs_serve_method) method.
 When using `FileSystemStorage`, documents are stored in a `documents` subdirectory within your site's `MEDIA_ROOT`.
 If all your documents are public, you can set the `WAGTAILDOCS_SERVE_METHOD` to `direct` and configure your web server to serve the files itself.
-However, if you use Wagtail's [Collection Privacy settings](collection_privacy_settings) to restrict access to some or all of your documents, you may or may not want to configure your web server to serve the documents directly.
+However, if you use Wagtail's [Collection Privacy settings](https://guide.wagtail.org/en-latest/how-to/managing-collections/#privacy-settings) to restrict access to some or all of your documents, you may or may not want to configure your web server to serve the documents directly.
 The default setting is `redirect` which allows Wagtail to perform any configured privacy checks before offloading serving the actual document to your web server or CDN.
 This means that Wagtail constructs document links that pass through Wagtail, but the final url in the user's browser is served directly by your web server.
 If a user bookmarks this url, they will be able to access the file without passing through Wagtail's privacy checks.

+ 2 - 0
docs/advanced_topics/performance.md

@@ -1,3 +1,5 @@
+(performance_overview)=
+
 # Performance
 
 Wagtail is designed for speed, both in the editor interface and on the front-end, but if you want even better performance or you need to handle very high volumes of traffic, here are some tips on eking out the most from your installation.

+ 1 - 1
docs/reference/contrib/redirects.md

@@ -33,7 +33,7 @@ This app contains migrations so make sure you run the `migrate` django-admin com
 
 Once installed, a new menu item called "Redirects" should appear in the "Settings" menu. This is where you can add arbitrary redirects to your site.
 
-For an editor's guide to the interface, see [](managing_redirects).
+For an editor's guide to the interface, see [Managing redirects](https://guide.wagtail.org/en-latest/how-to/managing-redirects/).
 
 ## Automatic redirect creation
 

+ 1 - 1
docs/reference/pages/panels.md

@@ -47,7 +47,7 @@ Here are some Wagtail-specific types that you might include as fields in your mo
 
     .. attribute:: FieldPanel.disable_comments (optional)
 
-        This allows you to prevent a field level comment button showing for this panel if set to ``True`` (see :ref:`commenting`).
+        This allows you to prevent a field level comment button showing for this panel if set to ``True``. See `Commenting <https://guide.wagtail.org/en-latest/how-to/creating-and-editing-pages/#commenting>`_.
 
     .. attribute:: FieldPanel.permission (optional)
 

+ 1 - 1
docs/reference/settings.md

@@ -387,7 +387,7 @@ You can use it to specify or override the widgets to use in the admin form.
 WAGTAILDOCS_SERVE_METHOD = 'redirect'
 ```
 
-Determines how document downloads will be linked to and served. Normally, requests for documents are sent through a Django view, to perform privacy checks (see [](collection_privacy_settings)) and potentially other housekeeping tasks such as hit counting. To fully protect against users bypassing this check, it needs to happen in the same request where the document is served; however, this incurs a performance hit as the document then needs to be served by the Django server. In particular, this cancels out much of the benefit of hosting documents on external storage, such as S3 or a CDN.
+Determines how document downloads will be linked to and served. Normally, requests for documents are sent through a Django view, to perform privacy checks (see [Collection Privacy settings](https://guide.wagtail.org/en-latest/how-to/managing-collections/#privacy-settings)) and potentially other housekeeping tasks such as hit counting. To fully protect against users bypassing this check, it needs to happen in the same request where the document is served; however, this incurs a performance hit as the document then needs to be served by the Django server. In particular, this cancels out much of the benefit of hosting documents on external storage, such as S3 or a CDN.
 
 For this reason, Wagtail provides a number of serving methods which trade some of the strictness of the permission check for performance:
 

+ 2 - 2
docs/releases/2.10.rst

@@ -17,7 +17,7 @@ Moderation workflow
 
 This release introduces a configurable moderation workflow system to replace the single-step "submit for moderation" feature. Workflows can be set up on specific subsections of the page tree and consist of any number of tasks to be completed by designated user groups. To support this, numerous UI improvements have been made to Wagtail's page editor, including a new log viewer to track page history.
 
-For further details, see :ref:`managing_workflows` and :doc:`../extending/custom_tasks`.
+For further details, see `Managing Workflows <https://guide.wagtail.org/en-latest/how-to/configuring-moderation-workflows/>`_ and :doc:`../extending/custom_tasks`.
 
 This feature was developed by Jacob Topp-Mugglestone, Karl Hobley, Matt Westcott and Dan Braghis, and sponsored by `The Motley Fool <https://www.fool.com/>`_.
 
@@ -155,7 +155,7 @@ Key points:
   this should simply create a task approvable by anybody in the `Moderators` group, and assign a workflow with this task to the root page, creating a standard workflow
   for the entire page tree. However, if you have a complex nested set of publish page permissions, the created set of workflows will be more complex as well - you may wish to
   inspect the created workflows and tasks in the new ``Settings/Workflows`` admin area and potentially simplify them.
-  See :ref:`managing_workflows` for the administrator guide.
+  See `Managing Workflows <https://guide.wagtail.org/en-latest/how-to/configuring-moderation-workflows/>`_ for the administrator guide.
 
 
 ``<div class="rich-text">`` wrappers removed from rich text

+ 1 - 1
docs/releases/2.11.rst

@@ -139,7 +139,7 @@ Adding the ``run_before`` directive will ensure that the migrations run in the i
 IE11 support being phased out
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-This release begins the process of phasing out support for Internet Explorer. Please see :ref:`ie11` for details of the timeline over which support will be dropped.
+This release begins the process of phasing out support for Internet Explorer.
 
 
 SiteMiddleware moved to ``wagtail.contrib.legacy``

+ 1 - 1
docs/releases/4.2.md

@@ -86,7 +86,7 @@ This feature was developed by Jake Howard.
  * Add custom permissions section to permissions documentation page (Dan Hayden)
  * Add documentation for how to get started with [contributing translations](contributing_translations) for the Wagtail admin (Ogunbanjo Oluwadamilare)
  * Officially recommend `fnm` over `nvm` in development documentation (LB (Ben) Johnston)
- * Mention the importance of passing `request` and `current_site` to `get_url` on the [performance](performance) documentation page (Jake Howard)
+ * Mention the importance of passing `request` and `current_site` to `get_url` on the [performance](performance_overview) documentation page (Jake Howard)
  * Add documentation for [`register_user_listing_buttons`](register_user_listing_buttons) hook (LB (Ben Johnston))
  * Add development (contributing to Wagtail) documentation notes for [development on Windows](development_on_windows) (Akua Dokua Asiedu)
  * Mention Wagtail’s usage of Django’s default user model by default (Temidayo Azeez)

+ 1 - 1
docs/topics/permissions.md

@@ -1,4 +1,4 @@
-(permissions)=
+(permissions_overview)=
 
 # Permissions
 

+ 1 - 1
docs/topics/snippets.md

@@ -410,7 +410,7 @@ If you use the scheduled publishing feature, make sure that you run the [`publis
 For models that extend `DraftStateMixin`, `publish` permissions are automatically created.
 ```
 
-Publishing a snippet instance requires `publish` permission on the snippet model. For models with `DraftStateMixin` applied, Wagtail automatically creates the corresponding `publish` permissions and display them in the 'Groups' area of the Wagtail admin interface. For more details on how to configure the permission, see [](permissions).
+Publishing a snippet instance requires `publish` permission on the snippet model. For models with `DraftStateMixin` applied, Wagtail automatically creates the corresponding `publish` permissions and display them in the 'Groups' area of the Wagtail admin interface. For more details on how to configure the permission, see [](permissions_overview).
 
 ```{warning}
 Wagtail does not yet have a mechanism to prevent editors from including unpublished ("draft") snippets in pages. When including a `DraftStateMixin`-enabled snippet in pages, make sure that you add necessary checks to handle how a draft snippet should be rendered (e.g. by checking its `live` field). We are planning to improve this in the future.

+ 1 - 1
docs/topics/writing_templates.md

@@ -60,7 +60,7 @@ Any file within the static folder should be inserted into your HTML using the `{
 
 ### User images
 
-Images uploaded to a Wagtail site by its users (as opposed to a developer's static files, mentioned above) go into the image library and from there are added to pages via the [page editor interface](inserting_images).
+Images uploaded to a Wagtail site by its users (as opposed to a developer's static files, mentioned above) go into the image library and from there are added to pages via the page editor interface.
 
 Unlike other CMSs, adding images to a page does not involve choosing a "version" of the image to use. Wagtail has no predefined image "formats" or "sizes". Instead, the template developer defines image manipulation to occur _on the fly_ when the image is requested, via a special syntax within the template.