IMPORTANT: All these changes will be published in different commits on the same day.
Motivation
We focus on addressing the technical debt aggregated in the past 5 years to make Turms clearer and move faster.
Checklist
Project rename:
Rename turms-plugin-antispam to turms-plugin-content-moderation for clarity.
Rename turms-plugin-minio to turms-plugin-file-storage as we will support other providers (e.g. AWS S3).
Rename turms-plugin-rasa to turms-plugin-chatbot as we will support RAG based on LLM models.
Migration: It should be easy for users to migrate by using the new plugin names if they use these plugins.
Symbol rename:
Rename Query to Find of all usages for clarity.
Migration:
The related data in MongoDB will be migrated automatically when turms-service starts.
Users need to use the new API from queryXXX to findXXX on the client side.
Admin users need to use new admin permission names from e.g. USER_QUERY to USER_FIND (turms servers won't provide support for the legacy names).
Rename UserPermissionGroup to UserRole for clarity and consistency (AdminRole).
Migration: The data in MongoDB will be migrated automatically when turms-service starts, so users don't need to migrate it manually.
Refactor:
Refactor legacy admin API.
Migration: The new API fixes almost all problems in the legacy API, is consistent, clearer, and easier to use correctly, and introduces some new API features (e.g. all requests support limit), so it should be easy for users to migrate, but they indeed need to take some time to migrate from old API if they have used a lot of them.
Refactor legacy properties structure for clarity.
Migration: turms servers will not recognize the legacy/old properties, so users have to migrate their custom properties manually. As turms servers will throw on startup if they receive unknown properties, users can update their custom properties according to these errors and the full properties example.
Docs:
Update outdated docs
Introduce all new features that we haven't mentioned in docs, e.g. video conferencing.
Provide full properties example
Follow Conventional Commits for new commits to generate changelogs automatically.
IMPORTANT: All these changes will be published in different commits on the same day.
Motivation
We focus on addressing the technical debt aggregated in the past 5 years to make Turms clearer and move faster.
Checklist
Project rename:
turms-plugin-antispamtoturms-plugin-content-moderationfor clarity.turms-plugin-miniototurms-plugin-file-storageas we will support other providers (e.g. AWS S3).turms-plugin-rasatoturms-plugin-chatbotas we will support RAG based on LLM models.Migration: It should be easy for users to migrate by using the new plugin names if they use these plugins.
Symbol rename:
QuerytoFindof all usages for clarity. Migration:queryXXXtofindXXXon the client side.USER_QUERYtoUSER_FIND(turms servers won't provide support for the legacy names).UserPermissionGrouptoUserRolefor clarity and consistency (AdminRole). Migration: The data in MongoDB will be migrated automatically when turms-service starts, so users don't need to migrate it manually.Refactor:
limit), so it should be easy for users to migrate, but they indeed need to take some time to migrate from old API if they have used a lot of them.Docs:
Conventional Commitsfor new commits to generate changelogs automatically.