Fix broken links

pull/5917/head
Chocobozzz 2023-08-17 09:46:24 +02:00
parent 0632cdda04
commit cb78deba47
No known key found for this signature in database
GPG Key ID: 583A612D890159BE
4 changed files with 9 additions and 10 deletions

View File

@ -53,7 +53,7 @@ info:
} }
``` ```
We provide error `type` values for [a growing number of cases](https://github.com/Chocobozzz/PeerTube/blob/develop/packages/models/server/server-error-code.enum.ts), We provide error `type` values for [a growing number of cases](https://github.com/Chocobozzz/PeerTube/blob/develop/packages/models/src/server/server-error-code.enum.ts),
but it is still optional. Types are used to disambiguate errors that bear the same status code but it is still optional. Types are used to disambiguate errors that bear the same status code
and are non-obvious: and are non-obvious:
@ -8752,7 +8752,6 @@ components:
password: password:
$ref: '#/components/schemas/password' $ref: '#/components/schemas/password'
UpdateMe: UpdateMe:
# see packages/models/users/user-update-me.model.ts:
properties: properties:
password: password:
$ref: '#/components/schemas/password' $ref: '#/components/schemas/password'

View File

@ -26,7 +26,7 @@ Nothing to do here, Github will automatically send a webhook to Weblate that wil
## Support a new language ## Support a new language
* Add it to [/packages/models/i18n/i18n.ts](/packages/models/i18n/i18n.ts) * Add it to [/packages/models/i18n/i18n.ts](/packages/core-utils/src/i18n/i18n.ts)
* Add it to [/scripts/build/client.sh](/scripts/build/client.sh) * Add it to [/scripts/build/client.sh](/scripts/build/client.sh)
* Add it to [/client/angular.json](/client/angular.json) * Add it to [/client/angular.json](/client/angular.json)
* Add it to [/scripts/i18n/update.sh](/scripts/i18n/update.sh) * Add it to [/scripts/i18n/update.sh](/scripts/i18n/update.sh)

View File

@ -20,10 +20,10 @@ Some of these may be optional (for example your new endpoint may not need to sen
- Check new configuration keys are set in `server/server/initializers/checker-before-init.ts` - Check new configuration keys are set in `server/server/initializers/checker-before-init.ts`
- You can also ensure configuration consistency in `server/server/initializers/checker-after-init.ts` - You can also ensure configuration consistency in `server/server/initializers/checker-after-init.ts`
- If you want your configuration to be available in the client: - If you want your configuration to be available in the client:
+ Add your field in `packages/models/server/server/server-config.model.ts` + Add your field in `packages/models/src/server/server/server-config.model.ts`
+ Update `server/server/lib/server-config-manager.ts` to include your new configuration + Update `server/server/lib/server-config-manager.ts` to include your new configuration
- If you want your configuration to be updatable by the web admin in the client: - If you want your configuration to be updatable by the web admin in the client:
+ Add your field in `packages/models/server/server/custom-config.model.ts` + Add your field in `packages/models/src/server/server/custom-config.model.ts`
+ Add the configuration to the config object in the `server/server/controllers/api/config.ts` controller + Add the configuration to the config object in the `server/server/controllers/api/config.ts` controller
* Controllers: * Controllers:
- Create the controller file and fill it with your REST API routes - 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
* Create the migration file in `initializers/migrations` using Sequelize Query Interface (`.addColumn`, `.dropTable`, `.changeColumn`) * Create the migration file in `initializers/migrations` using Sequelize Query Interface (`.addColumn`, `.dropTable`, `.changeColumn`)
* Update `LAST_MIGRATION_VERSION` in `server/server/initializers/constants.ts` * Update `LAST_MIGRATION_VERSION` in `server/server/initializers/constants.ts`
* Notifications: * Notifications:
- Create the new notification model in `packages/models/users/user-notification.model.ts` - Create the new notification model in `packages/models/src/users/user-notification.model.ts`
- Create the notification logic in `server/server/lib/notifier/shared`: - Create the notification logic in `server/server/lib/notifier/shared`:
+ Email subject has a common prefix (defined by the admin in PeerTube configuration) + Email subject has a common prefix (defined by the admin in PeerTube configuration)
- Add your notification to `server/server/lib/notifier/notifier.ts` - 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
+ 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 + 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
- If you need to associate a new table with `userNotification`: - If you need to associate a new table with `userNotification`:
+ Associate the new table in `UserNotificationModel` (don't forget the index) + Associate the new table in `UserNotificationModel` (don't forget the index)
+ Add the object property in the API model definition (`packages/models/users/user-notification.model.ts`) + Add the object property in the API model definition (`packages/models/src/users/user-notification.model.ts`)
+ Add the object in `UserNotificationModel.toFormattedJSON` + Add the object in `UserNotificationModel.toFormattedJSON`
+ Handle this new notification type in client (`UserNotificationsComponent`) + Handle this new notification type in client (`UserNotificationsComponent`)
+ Handle the new object property in client model (`UserNotification`) + Handle the new object property in client model (`UserNotification`)
* Tests: * Tests:
- Create your command class in `packages/server-commands/` that will wrap HTTP requests to your new endpoint - Create your command class in `packages/server-commands/` that will wrap HTTP requests to your new endpoint
- Add your command file in `index.ts` of current directory - Add your command file in `index.ts` of current directory
- Instantiate your command class in `packages/server-commands/server/server/server.ts` - Instantiate your command class in `packages/server-commands/src/server/server.ts`
- Create your test file in `server/server/tests/api/check-params` to test middleware validators/authentification/user rights (offensive tests) - Create your test file in `server/server/tests/api/check-params` to test middleware validators/authentification/user rights (offensive tests)
- Add it to `server/server/tests/api/check-params/index.ts` - Add it to `server/server/tests/api/check-params/index.ts`
- Create your test file in `server/server/tests/api` to test your new endpoints - Create your test file in `server/server/tests/api` to test your new endpoints

View File

@ -387,7 +387,7 @@ function register (...) {
displayName: 'User display name', displayName: 'User display name',
// Custom admin flags (bypass video auto moderation etc.) // Custom admin flags (bypass video auto moderation etc.)
// https://github.com/Chocobozzz/PeerTube/blob/develop/packages/models/users/user-flag.model.ts // https://github.com/Chocobozzz/PeerTube/blob/develop/packages/models/src/users/user-flag.model.ts
// PeerTube >= 5.1 // PeerTube >= 5.1
adminFlags: 0, adminFlags: 0,
// Quota in bytes // Quota in bytes
@ -1032,7 +1032,7 @@ If you want to translate strings of your plugin (like labels of your registered
} }
``` ```
The key should be one of the locales defined in [i18n.ts](https://github.com/Chocobozzz/PeerTube/blob/develop/packages/models/i18n/i18n.ts). The key should be one of the locales defined in [i18n.ts](https://github.com/Chocobozzz/PeerTube/blob/develop/packages/core-utils/src/i18n/i18n.ts).
Translation files are just objects, with the english sentence as the key and the translation as the value. Translation files are just objects, with the english sentence as the key and the translation as the value.
`fr.json` could contain for example: `fr.json` could contain for example: