Browse Source

Add changelog & a few fixes for #11194

Partially reverts commit 7fa335c20d0f55d8634bf152fcae6cf3225d2695 (fixing some issues with the URL updates)
LB Johnston 1 year ago
parent
commit
bbcf1e74ee

+ 2 - 0
CHANGELOG.txt

@@ -85,6 +85,8 @@ Changelog
  * Docs: Clarify where documentation build commands should be run (Nikhil S Kalburgi)
  * Docs: Add missing import to tutorial BlogPage example (Salvo Polizzi)
  * Docs: Update contributing guide documentation and GitHub templates to better support new contributors (Thibaud Colas)
+ * Docs: Update MyST documentation parser library to v 2.0.0 (Neeraj Yetheendran)
+ * Docs: Add documentation writing guidelines for intersphinx / external links (LB (Ben) Johnston)
  * Maintenance: Update BeautifulSoup upper bound to 4.12.x (scott-8)
  * Maintenance: Migrate initialization of classes (such as `body.ready`) from multiple JavaScript implementations to one Stimulus controller `w-init` (Chiemezuo Akujobi)
  * Maintenance: Adopt the usage of of translate string literals using `arg=_('...')` in all `wagtailadmin` module templates (Chiemezuo Akujobi)

+ 1 - 1
docs/advanced_topics/third_party_tutorials.md

@@ -102,7 +102,7 @@ the latest Wagtail versions.
 -   [How To Alternate Blocks in Your Django & Wagtail Templates](https://www.coderedcorp.com/blog/how-to-alternate-blocks-in-your-templates/) (19 February 2021)
 -   [Build a Blog With Wagtail CMS (second version)](https://www.accordbox.com/blog/build-blog-wagtail-cms-second-version-available/) (13 January 2021)
 -   [Migrate your Wagtail Website from wagtailtrans to the new wagtail-localize](https://www.cnc.io/en/blog/wagtailtrans-to-wagtail-localize-migration) (10 January 2021)
--   [How to Use the Wagtail CMS for inv:django# An Overview](https://steelkiwi.com/blog/how-to-use-the-wagtail-cms-for-django-an-overview/) (21 December 2020)
+-   [How to Use the Wagtail CMS for Django: An Overview](https://steelkiwi.com/blog/how-to-use-the-wagtail-cms-for-django-an-overview/) (21 December 2020)
 -   [Wagtail `modeladmin` and a dynamic panels list](https://kuttler.eu/code/wagtail-modeladmin-and-dynamic-panels-list/) (14 December 2020)
 -   [Install and Deploy Wagtail CMS on pythonanywhere.com](https://www.theinsidetrade.com/blog/install-and-deploy-wagtail-cms-pythonanywherecom/) (14 December 2020)
 -   [Overriding the admin CSS in Wagtail](https://www.yellowduck.be/posts/overriding-the-admin-css-in-wagtail/) (4 December 2020)

+ 1 - 1
docs/contributing/developing.md

@@ -282,7 +282,7 @@ export DJANGO_SETTINGS_MODULE=wagtail.test.settings_ui
 npm run storybook
 ```
 
-The last command will start Storybook at `http://localhost:6006/`. It will proxy specific requests to Django at `http://localhost:8000` by default. Use the `TEST_ORIGIN` environment variable to use a different port for inv:django# `TEST_ORIGIN=http://localhost:9000 npm run storybook`.
+The last command will start Storybook at `http://localhost:6006/`. It will proxy specific requests to Django at `http://localhost:8000` by default. Use the `TEST_ORIGIN` environment variable to use a different port for Django: `TEST_ORIGIN=http://localhost:9000 npm run storybook`.
 
 ## Compiling the documentation
 

+ 7 - 1
docs/contributing/documentation_guidelines.md

@@ -229,10 +229,16 @@ You can select widgets from [Django's form widgets](inv:django#ref/forms/widgets
     This parameter allows you to specify a :doc:`Django form widget <django:ref/forms/widgets>` to use instead of the default widget for this field type.
 ```
 
-There is no support for id (hash) refs at this point, so these will need to be written out as full URLs, remember to use the `stable` URL and not a specific version.
+There is no support for id (hash) refs on pages at this time, so these will need to be written out as full URLs, remember to use the `stable` URL and not a specific version. In some cases you may be able to reference the name of the hash directly though.
 
 ```md
+<!-- #django-template-context-processors-i18n does not work, so a full URL will be needed -->
+
 [django.template.context_processors.i18n](https://docs.djangoproject.com/en/stable/ref/templates/api/#django-template-context-processors-i18n)
+
+<!--  #meta-and-multi-table-inheritance does work as a direct name reference -->
+
+[multi-table inheritance](inv:django#meta-and-multi-table-inheritance)
 ```
 
 ### Note and warning call-outs

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

@@ -309,7 +309,7 @@ See also [django-treebeard](https://django-treebeard.readthedocs.io/en/latest/in
 
     .. attribute:: is_creatable
 
-        Controls if this page can be created through the Wagtail administration. Defaults to ``True``, and is not inherited by subclasses. This is useful when using :ref:`multi-table inheritance <django:multi-table-inheritance>`, to stop the base model from being created as an actual page.
+        Controls if this page can be created through the Wagtail administration. Defaults to ``True``, and is not inherited by subclasses. This is useful when using :ref:`multi-table inheritance <django:meta-and-multi-table-inheritance>`, to stop the base model from being created as an actual page.
 
     .. attribute:: max_count
 

+ 2 - 0
docs/releases/6.0.md

@@ -123,6 +123,8 @@ Thank you to Thibaud Colas, Badr Fourane, and Sage Abdullah for their work on th
  * Add missing import to tutorial BlogPage example (Salvo Polizzi)
  * Update contributing guide documentation and GitHub templates to better support new contributors (Thibaud Colas)
  * Add more CSS authoring guidelines (Thibaud Colas)
+ * Update MyST documentation parser library to v 2.0.0 (Neeraj Yetheendran)
+ * Add documentation writing guidelines for intersphinx / external links (LB (Ben) Johnston)
 
 ### Maintenance