Skip to content

Commit 72ed6f8

Browse files
committed
Clarify branding
1 parent a9d04dd commit 72ed6f8

12 files changed

+18
-18
lines changed

blog/2022-10-29-email-verifications.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ A typical registration process goes as follows:
2121

2222
What’s wrong with this? Nothing. But like all things, as soon as real world complexity creeps in, this pattern could become painful. What if you wanted to send an email after the code or link expires? And do you really need a user in your database if they never verify their email address?
2323

24-
Let’s take this trivial example and replace it with a workflow. This is based on the [Workflow](https://github.com/laravel-workflow/laravel-workflow) library.
24+
Let’s take this trivial example and replace it with a workflow. This is based on the [Workflow library](https://github.com/laravel-workflow/laravel-workflow) (the Laravel-native durable workflow package).
2525

2626
Get Started
2727
===========

blog/2022-12-22-new-laravel-workflow-feature-side-effects.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Workflow is a powerful package for the Laravel web framework that provides tools
1515

1616
One of the key features of any workflow engine is the ability to track the history of a workflow as it is executed which allows a workflow to be retried if it fails or encounters an error. However, this also means that your workflow code must be deterministic and any non-deterministic code has to be carefully managed.
1717

18-
Recently, Workflow added support for [side effects](https://laravel-workflow.com/docs/features/side-effects), which are closures containing non-deterministic code that is only executed once and the result saved. Side effects are a useful way to introduce non-deterministic behavior into a workflow, such as generating a random number or UUID.
18+
Recently, the Workflow package added support for [side effects](https://laravel-workflow.com/docs/features/side-effects), which are closures containing non-deterministic code that is only executed once and the result saved. Side effects are a useful way to introduce non-deterministic behavior into a workflow, such as generating a random number or UUID.
1919

2020
Here is an example workflow that demonstrates side effects.
2121

blog/2023-04-05-introducing-child-workflows-in-laravel-workflow.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ tags: [child-workflows, nesting]
1111

1212
import ThemedImage from '@site/src/components/ThemedImage';
1313

14-
Workflow has introduced an exciting new feature called “Child Workflows.” This addition aims to enhance the organization and maintainability of complex processes by allowing developers to encapsulate sub-processes within a parent workflow. This article will discuss the benefits of using child workflows, their similarities with running a workflow as an activity, and their compatibility with retry and resume features.
14+
Workflow (the Laravel-native durable workflow package) has introduced an exciting new feature called “Child Workflows.” This addition aims to enhance the organization and maintainability of complex processes by allowing developers to encapsulate sub-processes within a parent workflow. This article will discuss the benefits of using child workflows, their similarities with running a workflow as an activity, and their compatibility with retry and resume features.
1515

1616
What are Child Workflows?
1717
=========================
1818

19-
In Workflow, child workflows are a way to manage complex processes by breaking them down into smaller, more manageable units. They enable developers to create hierarchical and modular structures for their workflows, making them more organized and easier to maintain. A child workflow is essentially a separate workflow that is invoked within a parent workflow using the `child()` helper function.
19+
In the Workflow package, child workflows are a way to manage complex processes by breaking them down into smaller, more manageable units. They enable developers to create hierarchical and modular structures for their workflows, making them more organized and easier to maintain. A child workflow is essentially a separate workflow that is invoked within a parent workflow using the `child()` helper function.
2020

2121
Benefits of Using Child Workflows
2222
=================================

blog/2023-04-25-combining-laravel-workflow-and-state-machines.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ authors:
99
tags: [side-effects, random, determinism]
1010
---
1111

12-
When it comes to building web applications, managing complex processes and activities can be a daunting task. Workflow simplifies this process by providing tools for defining and managing workflows and activities. In addition, integrating a state machine library can offer more explicit control over the transitions between states or activities, resulting in a more structured and visual representation of the workflow. In this blog post, we will explore the benefits of using Workflow along with a state machine and walk through an example of integrating Workflow with Finite, a simple state machine library.
12+
When it comes to building web applications, managing complex processes and activities can be a daunting task. Workflow (the Laravel-native durable workflow package) simplifies this process by providing tools for defining and managing workflows and activities. In addition, integrating a state machine library can offer more explicit control over the transitions between states or activities, resulting in a more structured and visual representation of the workflow. In this blog post, we will explore the benefits of using Workflow along with a state machine and walk through an example of integrating Workflow with Finite, a simple state machine library.
1313

1414
Benefits of Combining Workflow and State Machines
1515
=========================================================
1616

17-
Using Workflow and a state machine together provides several advantages:
17+
Using the Workflow package and a state machine together provides several advantages:
1818

1919
1. Flexibility and modularity: Workflow allows developers to break down complex processes into smaller, modular units that are easy to maintain and update.
2020
2. Explicit control over transitions: State machines provide a clear visualization of workflow states, activities, and transitions, making it easier to understand and maintain.

blog/2023-05-21-saga-pattern-and-laravel-workflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Sagas are an established design pattern for managing complex, long-running opera
3737
3. Each operation in the Saga can be reversed by a compensatory transaction.
3838
4. The Saga pattern assures that all operations are either completed successfully or the corresponding compensation transactions are run to reverse any completed work.
3939

40-
Workflow provides inherent support for the Saga pattern, simplifying the process of handling rollbacks and executing compensatory transactions.
40+
Workflow (the Laravel-native durable workflow package) provides inherent support for the Saga pattern, simplifying the process of handling rollbacks and executing compensatory transactions.
4141

4242
Booking Saga Flow
4343
=================

docs/configuration/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
"position": 5,
44
"link": {
55
"type": "generated-index",
6-
"description": "Workflow allows you to specify various options when defining your workflows and activities."
6+
"description": "The Workflow package allows you to specify various options when defining your workflows and activities."
77
}
88
}

docs/configuration/options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_position: 2
44

55
# Options
66

7-
Workflow allows you to specify various options when defining your workflows and activities. These options include the number of times a workflow or activity may be attempted before it fails, the connection and queue, and the maximum number of seconds it is allowed to run.
7+
The Workflow package allows you to specify various options when defining your workflows and activities. These options include the number of times a workflow or activity may be attempted before it fails, the connection and queue, and the maximum number of seconds it is allowed to run.
88

99
```php
1010
use Workflow\Activity;

docs/constraints/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
"position": 7,
44
"link": {
55
"type": "generated-index",
6-
"description": "Workflow's determinism and idempotency constraints for workflows and activities are important for ensuring the reliability and correctness of the overall system."
6+
"description": "The Workflow package's determinism and idempotency constraints for workflows and activities are important for ensuring the reliability and correctness of the overall system."
77
}
88
}

docs/features/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
"position": 4,
44
"link": {
55
"type": "generated-index",
6-
"description": "Workflow provides methods for executing activities, handling errors and retries, and communicating with the workflow."
6+
"description": "The Workflow package provides methods for executing activities, handling errors and retries, and communicating with the workflow."
77
}
88
}

docs/installation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@ Workflow also requires a cache driver that supports [locks](https://laravel.com/
2424

2525
> ✨ SQS Support: `timer()` and `awaitWithTimeout()` work with any duration, even when using the SQS queue driver. Workflow automatically handles SQS's delay limitation transparently.
2626
27-
## Installing Workflow
27+
## Installing the Workflow package
2828

29-
Workflow is installable via Composer. To install it, run the following command in your Laravel project:
29+
The Workflow package is installable via Composer. To install it, run the following command in your Laravel project:
3030

3131
```bash
3232
composer require laravel-workflow/laravel-workflow
3333
```
3434

35-
After installing Workflow, you must also publish the migrations. To publish the migrations, run the following command:
35+
After installing the Workflow package, you must also publish the migrations. To publish the migrations, run the following command:
3636

3737
```bash
3838
php artisan vendor:publish --provider="Workflow\Providers\WorkflowServiceProvider" --tag="migrations"
@@ -46,4 +46,4 @@ php artisan migrate
4646

4747
## Running Workers
4848

49-
Workflow uses queues to run workflows and activities in the background. You will need to either run the `queue:work` [command](https://laravel.com/docs/12.x/queues#the-queue-work-command) or use [Horizon](https://laravel.com/docs/12.x/horizon) to run your queue workers. Without a queue worker, workflows and activities will not be processed. You cannot use the sync driver with queue workers.
49+
The Workflow package uses queues to run workflows and activities in the background. You will need to either run the `queue:work` [command](https://laravel.com/docs/12.x/queues#the-queue-work-command) or use [Horizon](https://laravel.com/docs/12.x/horizon) to run your queue workers. Without a queue worker, workflows and activities will not be processed. You cannot use the sync driver with queue workers.

0 commit comments

Comments
 (0)