aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/development
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2023-08-17 09:46:24 +0200
committerChocobozzz <me@florianbigard.com>2023-08-17 09:46:24 +0200
commitcb78deba475773d208ae0ff32107fc5dd3dde11f (patch)
tree490ae4ea608efe59002c310d4c731002d637ffea /support/doc/development
parent0632cdda04cdc3672de9a71b16c67267e420953f (diff)
downloadPeerTube-cb78deba475773d208ae0ff32107fc5dd3dde11f.tar.gz
PeerTube-cb78deba475773d208ae0ff32107fc5dd3dde11f.tar.zst
PeerTube-cb78deba475773d208ae0ff32107fc5dd3dde11f.zip
Fix broken links
Diffstat (limited to 'support/doc/development')
-rw-r--r--support/doc/development/localization.md2
-rw-r--r--support/doc/development/server.md10
2 files changed, 6 insertions, 6 deletions
diff --git a/support/doc/development/localization.md b/support/doc/development/localization.md
index 4aca9b18b..7c9ef0172 100644
--- a/support/doc/development/localization.md
+++ b/support/doc/development/localization.md
@@ -26,7 +26,7 @@ Nothing to do here, Github will automatically send a webhook to Weblate that wil
26 26
27## Support a new language 27## Support a new language
28 28
29 * Add it to [/packages/models/i18n/i18n.ts](/packages/models/i18n/i18n.ts) 29 * Add it to [/packages/models/i18n/i18n.ts](/packages/core-utils/src/i18n/i18n.ts)
30 * Add it to [/scripts/build/client.sh](/scripts/build/client.sh) 30 * Add it to [/scripts/build/client.sh](/scripts/build/client.sh)
31 * Add it to [/client/angular.json](/client/angular.json) 31 * Add it to [/client/angular.json](/client/angular.json)
32 * Add it to [/scripts/i18n/update.sh](/scripts/i18n/update.sh) 32 * Add it to [/scripts/i18n/update.sh](/scripts/i18n/update.sh)
diff --git a/support/doc/development/server.md b/support/doc/development/server.md
index 5c83af704..70734ec3e 100644
--- a/support/doc/development/server.md
+++ b/support/doc/development/server.md
@@ -20,10 +20,10 @@ Some of these may be optional (for example your new endpoint may not need to sen
20 - Check new configuration keys are set in `server/server/initializers/checker-before-init.ts` 20 - Check new configuration keys are set in `server/server/initializers/checker-before-init.ts`
21 - You can also ensure configuration consistency in `server/server/initializers/checker-after-init.ts` 21 - You can also ensure configuration consistency in `server/server/initializers/checker-after-init.ts`
22 - If you want your configuration to be available in the client: 22 - If you want your configuration to be available in the client:
23 + Add your field in `packages/models/server/server/server-config.model.ts` 23 + Add your field in `packages/models/src/server/server/server-config.model.ts`
24 + Update `server/server/lib/server-config-manager.ts` to include your new configuration 24 + Update `server/server/lib/server-config-manager.ts` to include your new configuration
25 - If you want your configuration to be updatable by the web admin in the client: 25 - If you want your configuration to be updatable by the web admin in the client:
26 + Add your field in `packages/models/server/server/custom-config.model.ts` 26 + Add your field in `packages/models/src/server/server/custom-config.model.ts`
27 + Add the configuration to the config object in the `server/server/controllers/api/config.ts` controller 27 + Add the configuration to the config object in the `server/server/controllers/api/config.ts` controller
28 * Controllers: 28 * Controllers:
29 - Create the controller file and fill it with your REST API routes 29 - Create the controller file and fill it with your REST API routes
@@ -57,7 +57,7 @@ Some of these may be optional (for example your new endpoint may not need to sen
57 * Create the migration file in `initializers/migrations` using Sequelize Query Interface (`.addColumn`, `.dropTable`, `.changeColumn`) 57 * Create the migration file in `initializers/migrations` using Sequelize Query Interface (`.addColumn`, `.dropTable`, `.changeColumn`)
58 * Update `LAST_MIGRATION_VERSION` in `server/server/initializers/constants.ts` 58 * Update `LAST_MIGRATION_VERSION` in `server/server/initializers/constants.ts`
59 * Notifications: 59 * Notifications:
60 - Create the new notification model in `packages/models/users/user-notification.model.ts` 60 - Create the new notification model in `packages/models/src/users/user-notification.model.ts`
61 - Create the notification logic in `server/server/lib/notifier/shared`: 61 - Create the notification logic in `server/server/lib/notifier/shared`:
62 + Email subject has a common prefix (defined by the admin in PeerTube configuration) 62 + Email subject has a common prefix (defined by the admin in PeerTube configuration)
63 - Add your notification to `server/server/lib/notifier/notifier.ts` 63 - Add your notification to `server/server/lib/notifier/notifier.ts`
@@ -66,14 +66,14 @@ Some of these may be optional (for example your new endpoint may not need to sen
66 + The template usually extends `../common/grettings` that already says "Hi" and "Cheers". You just have to write the title and the content blocks that will be inserted in the appropriate places in the HTML template 66 + The template usually extends `../common/grettings` that already says "Hi" and "Cheers". You just have to write the title and the content blocks that will be inserted in the appropriate places in the HTML template
67 - If you need to associate a new table with `userNotification`: 67 - If you need to associate a new table with `userNotification`:
68 + Associate the new table in `UserNotificationModel` (don't forget the index) 68 + Associate the new table in `UserNotificationModel` (don't forget the index)
69 + Add the object property in the API model definition (`packages/models/users/user-notification.model.ts`) 69 + Add the object property in the API model definition (`packages/models/src/users/user-notification.model.ts`)
70 + Add the object in `UserNotificationModel.toFormattedJSON` 70 + Add the object in `UserNotificationModel.toFormattedJSON`
71 + Handle this new notification type in client (`UserNotificationsComponent`) 71 + Handle this new notification type in client (`UserNotificationsComponent`)
72 + Handle the new object property in client model (`UserNotification`) 72 + Handle the new object property in client model (`UserNotification`)
73 * Tests: 73 * Tests:
74 - Create your command class in `packages/server-commands/` that will wrap HTTP requests to your new endpoint 74 - Create your command class in `packages/server-commands/` that will wrap HTTP requests to your new endpoint
75 - Add your command file in `index.ts` of current directory 75 - Add your command file in `index.ts` of current directory
76 - Instantiate your command class in `packages/server-commands/server/server/server.ts` 76 - Instantiate your command class in `packages/server-commands/src/server/server.ts`
77 - Create your test file in `server/server/tests/api/check-params` to test middleware validators/authentification/user rights (offensive tests) 77 - Create your test file in `server/server/tests/api/check-params` to test middleware validators/authentification/user rights (offensive tests)
78 - Add it to `server/server/tests/api/check-params/index.ts` 78 - Add it to `server/server/tests/api/check-params/index.ts`
79 - Create your test file in `server/server/tests/api` to test your new endpoints 79 - Create your test file in `server/server/tests/api` to test your new endpoints