Browse Source

Add clarification on where to register entity plugins (#9487)

Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
ChickenF622 2 years ago
parent
commit
4ee7a633b6
4 changed files with 6 additions and 2 deletions
  1. 1 0
      CHANGELOG.txt
  2. 1 0
      CONTRIBUTORS.rst
  3. 1 0
      docs/extending/extending_draftail.md
  4. 3 2
      docs/releases/4.2.md

+ 1 - 0
CHANGELOG.txt

@@ -37,6 +37,7 @@ Changelog
  * Docs: Add development (contributing to Wagtail) documentation notes for development on Windows (Akua Dokua Asiedu)
  * Docs: Mention Wagtail’s usage of Django’s default user model by default (Temidayo Azeez)
  * Docs: Add links to treebeard documentation for relevant methods (Temidayo Azeez)
+ * Docs: Add clarification on where to register entity plugins (ChickenF622)
  * Maintenance: Remove unsquashed `testapp` migrations (Matt Westcott)
  * Maintenance: Upgrade to Node 18 for frontend build tooling (LB (Ben) Johnston)
  * Maintenance: Run Python tests with coverage and upload coverage data to codecov (Sage Abdullah)

+ 1 - 0
CONTRIBUTORS.rst

@@ -668,6 +668,7 @@ Contributors
 * Elizabeth Bassey
 * Suyash Singh
 * Temidayo Azeez
+* ChickenF622
 
 Translators
 ===========

+ 1 - 0
docs/extending/extending_draftail.md

@@ -306,6 +306,7 @@ This is a straightforward React component. It does not use JSX since we do not w
 Finally, we register the JS components of our plugin:
 
 ```javascript
+// Register the plugin directly on script execution so the editor loads it when initialising.
 window.draftail.registerPlugin({
     type: 'STOCK',
     source: StockSource,

+ 3 - 2
docs/releases/4.2.md

@@ -51,8 +51,9 @@ depth: 1
  * Mention the importance of passing `request` and `current_site` to `get_url` on the [performance](performance) 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)
- * Docs: Mention Wagtail’s usage of Django’s default user model by default (Temidayo Azeez)
- * Docs: Add links to treebeard documentation for relevant methods (Temidayo Azeez)
+ * Mention Wagtail’s usage of Django’s default user model by default (Temidayo Azeez)
+ * Add links to treebeard documentation for relevant methods (Temidayo Azeez)
+ * Add clarification on where to register entity plugins (ChickenF622)
 
 ### Maintenance