Skip to content

Commit 7cc0e7f

Browse files
committed
[docs] Migrate Privacy API docs
1 parent 11bc743 commit 7cc0e7f

File tree

9 files changed

+995
-6
lines changed

9 files changed

+995
-6
lines changed

data/migratedPages.yml

+3
Original file line numberDiff line numberDiff line change
@@ -1398,6 +1398,9 @@ Plugin_files:
13981398
Plugin_types:
13991399
- filePath: "/docs/apis/plugintypes/index.md"
14001400
slug: "/docs/apis/plugintypes/"
1401+
Privacy_API:
1402+
- filePath: "/docs/apis/subsystems/privacy/index.md"
1403+
slug: "/docs/apis/subsystems/privacy/"
14011404
Process:
14021405
- filePath: "/general/development/process.md"
14031406
slug: "/general/development/process"

docs/apis.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ The [Portfolio API](https://docs.moodle.org/dev/Portfolio_API) allows you to add
163163

164164
### Privacy API (privacy)
165165

166-
The [Privacy API](https://docs.moodle.org/dev/Privacy_API) allows you to describe the personal data that you store, and provides the means for that data to be discovered, exported, and deleted on a per-user basis.
166+
The [Privacy API](./apis/subsystems/privacy/index.md) allows you to describe the personal data that you store, and provides the means for that data to be discovered, exported, and deleted on a per-user basis.
167167
This allows compliance with regulation such as the General Data Protection Regulation (GDPR) in Europe.
168168

169169
### Rating API (rating)
Loading
Loading

docs/apis/subsystems/privacy/index.md

+984
Large diffs are not rendered by default.

general/development/process/peer-review.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ Ensure that:
150150
- Provide a way to delete that data.
151151

152152
:::info
153-
See more info in [Privacy API](https://docs.moodle.org/dev/Privacy_API).
153+
See more info in [Privacy API](/docs/apis/subsystems/privacy/).
154154
:::
155155

156156
### Performance and clustering

general/releases/3.5.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ See also [Message API#Changes in Moodle 3.5](https://docs.moodle.org/dev/Message
162162

163163
### For developers
164164

165-
- [MDL-61307](https://tracker.moodle.org/browse/MDL-61307) - All plugins must implement [Privacy API](https://docs.moodle.org/dev/Privacy_API) to be compliant with GDPR requirements. They must implement the API to report on, export and delete stored user data
165+
- [MDL-61307](https://tracker.moodle.org/browse/MDL-61307) - All plugins must implement [Privacy API](/docs/apis/subsystems/privacy/) to be compliant with GDPR requirements. They must implement the API to report on, export and delete stored user data
166166
- [MDL-56511](https://tracker.moodle.org/browse/MDL-56511) - Bootstrap is upgraded to final release of version 4
167167
- [MDL-61869](https://tracker.moodle.org/browse/MDL-61869) - Infer rendering of templatables with no render method
168168
- [MDL-61298](https://tracker.moodle.org/browse/MDL-61298) - Boost: use navigation node icon

general/releases/3.6.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -203,10 +203,10 @@ Note that some of these GDPR improvements have also been backported to Moodle 3.
203203

204204
In addition to existing requirements, any plugin which implements the plugin provider interface must also implement the <tt>\core_privacy\local\request\core_userlist_provider</tt> interface. Two new methods need to be implemented:
205205

206-
- [get users in context()](https://docs.moodle.org/dev/Privacy_API#Retrieving_the_users_in_a_context)
207-
- [delete data for users()](https://docs.moodle.org/dev/Privacy_API#Delete_personal_information_for_several_users_in_a_specific_context)
206+
- [get users in context()](/docs/apis/subsystems/privacy/#retrieving-the-users-in-a-context)
207+
- [delete data for users()](/docs/apis/subsystems/privacy/#delete-personal-information-for-several-users-in-a-specific-context)
208208

209-
However, the two above methods are not required for plugins that [implement the <tt>null provider</tt>](https://docs.moodle.org/dev/Privacy_API#Plugins_which_do_not_store_personal_data) only (i.e. which do not store personal data).
209+
However, the two above methods are not required for plugins that [implement the <tt>null provider</tt>](/docs/apis/subsystems/privacy/#plugins-which-do-not-store-personal-data) only (i.e. which do not store personal data).
210210

211211
Note that these changes are also required for latest Moodle 3.4.6 and 3.5.3 versions.
212212

project-words.txt

+2
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,7 @@ pluginable
220220
plugininfo
221221
pluginname
222222
plugintype
223+
plugintypes
223224
previewquestion
224225
privatefiles
225226
protectusernames
@@ -251,6 +252,7 @@ splitview
251252
strftimedate
252253
strikethrough
253254
subplugin
255+
subplugins
254256
tablespace
255257
tasklogs
256258
templatable

0 commit comments

Comments
 (0)