update doc

Author: cunla

docs/index.md

@@ -10,6 +10,10 @@ A database backed asynchronous tasks scheduler for django.
 This allows remembering scheduled tasks, their parameters, etc.
 
 !!! Important
+    Version 3.0.0 introduced a major design change. Instead of three separate models, there is one new `Task` model.
+    The goal is to simplify.
+    Make sure to follow [the migration guide](migrate_to_v3.md)
+
 
 ## Terminology
 

docs/migrate_to_v3.md

@@ -0,0 +1,36 @@
+Migration from v2 to v3
+=======================
+
+Version 3.0.0 introduced a major design change. Instead of three separate models, there is one new `Task` model. The
+goal is to have one centralized admin view for all your scheduled tasks, regardless of the scheduling type.
+
+You need to migrate the scheduled tasks using the old models (`ScheduledTask`, `RepeatableTask`, `CronTask`) to the new
+model. It can be done using the export/import commands provided.
+
+After upgrading to django-tasks-scheduler v3.0.0, you will notice you are not able to create new scheduled tasks in the
+old models, that is intentional. In the next version of django-tasks-scheduler (v3.1), the old models will be deleted,
+so make sure you migrate your old models.
+
+!!! Note
+    While we tested different scenarios heavily and left the code for old tasks, we could not account for all different
+    use cases, therefore, please [open an issue][issues] if you encounter any.
+
+There are two ways to migrate your existing scheduled tasks:
+
+# Using the admin views of the old models
+
+If you go to the admin view of the old models, you will notice there is a new action in the actions drop down menu for
+migrating the selected tasks. Use it, and you will also have a link to the new task to compare the migration result.
+
+Note once you migrate using this method, the old task will be disabled automatically.
+
+# Export/Import management commands
+
+Run in your project directory:
+
+```shell
+python manage.py export > scheduled_tasks.json
+python manage.py import --filename scheduled_tasks.json
+```
+
+[issues]: https://github.com/django-commons/django-tasks-scheduler/issues

mkdocs.yml

@@ -101,6 +101,7 @@ theme:
 
 nav:
   - Home: index.md
+  - Migrate v2 to v3: migrate_to_v3.md
   - Installation: installation.md
   - Configuration: configuration.md
   - Usage: usage.md

pyproject.toml

@@ -7,7 +7,7 @@ name = "django-tasks-scheduler"
 packages = [
     { include = "scheduler" },
 ]
-version = "2.2.0"
+version = "3.0.0"
 description = "An async job scheduler for django using redis/valkey brokers"
 readme = "README.md"
 keywords = ["redis", "valkey", "django", "background-jobs", "job-queue", "task-queue", "redis-queue", "scheduled-jobs"]