Skip to content

Commit 477852f

Browse files
committed
[repo] Update to respect strict admonitions
This change is required for Docusaurus 3.10 https://docusaurus.io/blog/releases/3.10#strict-admonitions
1 parent 4d1d674 commit 477852f

397 files changed

Lines changed: 702 additions & 702 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/apis/_files/db-access-php.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The `db/access.php` file contains the __initial__ configuration for a plugin's a
44

55
Access control is handled in Moodle by the use of Roles, and Capabilities. You can read more about these in the [Access API](../subsystems/access.md) documentation.
66

7-
:::caution Changing initial configuration
7+
:::caution[Changing initial configuration]
88

99
If you make changes to the initial configuration of _existing_ access control rules, these will only take effect for _new installations of your plugin_. Any existing installation **will not** be updated with the latest configuration.
1010

docs/apis/_files/db-events-php.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The `db/events.php` file allows you define any event subscriptions that your plu
55

66
Event subscriptions are a convenient way to observe events generated elsewhere in Moodle.
77

8-
:::caution Communication between components
8+
:::caution[Communication between components]
99

1010
You _should not_ use event subscriptions to subscribe to events belonging to other plugins, without defining a dependency upon that plugin.
1111

docs/apis/_files/db-tasks-php.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The `db/tasks.php` file contains the initial schedule configuration for each of your plugins _scheduled_ tasks. Adhoc tasks are not run on a regular schedule and therefore are not described in this file.
44

5-
:::caution Editing the schedule for an existing task
5+
:::caution[Editing the schedule for an existing task]
66

77
If an existing task is edited, it will only be updated in the database if the administrator has not customised the schedule of that task in any way.
88

docs/apis/_files/db-upgrade-php.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ The `db/upgrade.php` file contains upgrade steps, including database schema chan
33

44
See the [Upgrade API](../../guides/upgrade/index.md) documentation for further information.
55

6-
:::danger Generating Database Schema changes
6+
:::danger[Generating Database Schema changes]
77

88
When making changes to the database schema you **must** use the build-in [XMLDB editor](https://docs.moodle.org/dev/XMLDB_Documentation) within
99
Moodle. This can be used to generate php upgrade steps.

docs/apis/_files/lang-extra.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{/* <!-- markdownlint-disable MD041 --> */}
22

3-
:::caution Activity modules are different
3+
:::caution[Activity modules are different]
44

55
Activity modules do not use the __frankenstyle__ name as a filename, they use the plugin name. For example the forum activity plugin:
66

docs/apis/_files/lib.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The `lib.php` file is a legacy file which acts as a bridge between Moodle core,
44

55
All functions defined in this file **must** meet the requirements set out in the relevant section of the [Coding style](/general/development/policies/codingstyle#functions-and-methods).
66

7-
:::note Performance impact
7+
:::note[Performance impact]
88

99
Moodle core often loads all the <tt>lib.php</tt> files of a given plugin types. For performance reasons, it is strongly recommended to keep this file as small as possible and have just required code implemented in it. All the plugin's internal logic should be implemented in the auto-loaded classes.
1010

docs/apis/_files/locallib.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{/* <!-- markdownlint-disable first-line-heading --> */}
22
{/* <!-- cspell:ignore locallib --> */}
33

4-
:::caution Legacy feature
4+
:::caution[Legacy feature]
55

66
The use of this file is no longer recommended, and new uses of it will not be permitted in core code.
77

docs/apis/_files/styles-css.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Plugins may define a '/styles.css' to provide plugin-specific styling. See the f
44
- [Plugin contribution checklist#CSS styles](/general/community/plugincontribution/checklist#css-styles)
55
- [CSS Coding Style](https://docs.moodle.org/dev/CSS_Coding_Style)
66

7-
:::tip Avoid custom styles where possible
7+
:::tip[Avoid custom styles where possible]
88

99
Rather than writing custom CSS for your plugin, where possible apply Bootstrap classes to the DOM elements in your output. These will be easier to maintain and will adopt most colour, branding, and other customisations applied to a theme.
1010

docs/apis/_files/thirdpartylibs-xml.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This information is used to generate ignore file configuration for linting tools
55

66
Within the XML the `location` is a file, or directory, relative to your plugin's root.
77

8-
:::caution Licensing
8+
:::caution[Licensing]
99

1010
The license of any third-party code included in your plugin, and within the `thirdpartylibs.xml` file **must** be [compatible with the GNU GPLv3](http://www.gnu.org/licenses/license-list.html#GPLCompatibleLicenses).
1111

docs/apis/_files/upgrade-php.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ The `db/upgrade.php` file contains upgrade steps, including database schema chan
33

44
See the [Upgrade API](../../guides/upgrade/index.md) documentation for further information.
55

6-
:::danger Generating Database Schema changes
6+
:::danger[Generating Database Schema changes]
77

88
When making changes to the database schema you **must** use the build-in [XMLDB editor](https://docs.moodle.org/dev/XMLDB_Documentation) within
99
Moodle. This can be used to generate php upgrade steps.

0 commit comments

Comments
 (0)