From 11e028a0eb9106f1aa8252bd19e64c84bb7a8e28 Mon Sep 17 00:00:00 2001 From: ahmetfarukulu Date: Tue, 31 Dec 2024 10:47:47 +0300 Subject: [PATCH] docs: add background jobs documentation and update navigation links --- .../background-jobs.md | 19 +++++++++++++++++++ .../layered-web-application/index.md | 2 ++ .../swagger-integration.md | 4 ++-- 3 files changed, 23 insertions(+), 2 deletions(-) create mode 100644 docs/en/solution-templates/layered-web-application/background-jobs.md diff --git a/docs/en/solution-templates/layered-web-application/background-jobs.md b/docs/en/solution-templates/layered-web-application/background-jobs.md new file mode 100644 index 0000000000..beef27d5d0 --- /dev/null +++ b/docs/en/solution-templates/layered-web-application/background-jobs.md @@ -0,0 +1,19 @@ +# Layered Solution: Background Jobs + +```json +//[doc-nav] +{ + "Previous": { + "Name": "Swagger integration", + "Path": "solution-templates/layered-web-application/swagger-integration" + }, + "Next": { + "Name": "Background Workers", + "Path": "solution-templates/layered-web-application/background-workers" + } +} +``` + +Background jobs are long-running, asynchronous tasks that operate in the background of your application. They are ideal for non-time-sensitive tasks, such as sending emails, generating reports, or processing data. These jobs are usually triggered by a user action or a scheduled task. For more information, refer to the [Background Jobs](../../framework/infrastructure/background-jobs/index.md) document. + +In the layered solution template, background jobs are implemented using the [Background Jobs](../../modules/background-jobs.md) module. This module offers a simple and efficient way to create and manage background jobs in your application. It provides features like job queues and job scheduling. Job information is stored in the database, enabling you to track job statuses and retry failed jobs. \ No newline at end of file diff --git a/docs/en/solution-templates/layered-web-application/index.md b/docs/en/solution-templates/layered-web-application/index.md index d579b317b0..0c2e4fdef0 100644 --- a/docs/en/solution-templates/layered-web-application/index.md +++ b/docs/en/solution-templates/layered-web-application/index.md @@ -29,6 +29,8 @@ ABP Studio provides pre-architected, production-ready templates to jump-start a * [Database configurations](database-configurations.md) * [Logging (with Serilog)](logging.md) * [Swagger integration](swagger-integration.md) + * [Bacground Jobs](background-jobs.md) + * [Background Workers](background-workers.md) * [Multi-Tenancy](multi-tenancy.md) * [BLOB storing](blob-storing.md) * [CORS configuration](cors-configuration.md) diff --git a/docs/en/solution-templates/layered-web-application/swagger-integration.md b/docs/en/solution-templates/layered-web-application/swagger-integration.md index 049c30edc7..202ab9f892 100644 --- a/docs/en/solution-templates/layered-web-application/swagger-integration.md +++ b/docs/en/solution-templates/layered-web-application/swagger-integration.md @@ -8,8 +8,8 @@ "Path": "solution-templates/layered-web-application/logging" }, "Next": { - "Name": "Multi-Tenancy", - "Path": "solution-templates/layered-web-application/multi-tenancy" + "Name": "Background Jobs", + "Path": "solution-templates/layered-web-application/background-jobs" } } ```