Skip to content

Commit 824a640

Browse files
Update docs
1 parent 17a053c commit 824a640

File tree

12 files changed

+133
-44
lines changed

12 files changed

+133
-44
lines changed

docs/.vuepress/config.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,10 @@ export default defineUserConfig({
7171

7272
navbar: [
7373
{
74-
text: '5.x',
74+
text: '6.x',
7575
children: [
76-
{text: '5.x', link: '/getting-started/installation/index.md'},
76+
{text: '6.x', link: '/getting-started/installation/index.md'},
77+
{text: '5.x', link: 'https://github.com/TheDragonCode/laravel-deploy-operations/blob/5.x/docs/index.md'},
7778
{text: '4.x', link: 'https://github.com/TheDragonCode/laravel-deploy-operations/blob/4.x/docs/index.md'},
7879
{text: '3.x', link: 'https://github.com/TheDragonCode/laravel-deploy-operations/blob/3.x/docs/index.md'},
7980
]

docs/getting-started/installation/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Installation
22

3-
To get the latest version of `Deploy Operations for Laravel`, simply require the project using [Composer](https://getcomposer.org):
3+
To get the latest version of `Deploy Operations for Laravel`, require the project using [Composer](https://getcomposer.org):
44

55
```bash
66
composer require dragon-code/laravel-deploy-operations

docs/helpers/artisan.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# Artisan Command
22

3-
Quite often, when working with operations, it becomes necessary to run one or another console command, and each time you have to write the following code:
3+
Quite often, when working with operations, it becomes necessary to run one or another console command,
4+
and each time you have to write the following code:
45

56
```php
67
use DragonCode\LaravelDeployOperations\Operation;
78

8-
return new class () extends Operation
9+
return new class extends Operation
910
{
1011
public function __invoke(): void
1112
{

docs/helpers/events.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ DragonCode\LaravelDeployOperations\Events\NoPendingDeployOperations::class
1111

1212
If there are no operation files to execute, the `NoPendingDeployOperations` event will be sent.
1313

14-
In other cases, the `DeployOperationStarted` event will be sent before processing starts, and the `DeployOperationEnded` event will be sent after processing.
14+
In other cases, the `DeployOperationStarted` event will be sent before processing starts,
15+
and the `DeployOperationEnded` event will be sent after processing.
1516

1617
For example:
1718

docs/helpers/execution-status.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ You can also override the `success` and `failed` methods, which are called on su
88
use DragonCode\LaravelDeployOperations\Operation;
99
use Illuminate\Support\Facade\Log;
1010

11-
return new class () extends Operation
11+
return new class extends Operation
1212
{
1313
public function up(): void
1414
{

docs/how-to-use/creating.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ By default, the new operation class will contain the `__invoke` method, but you
7171
```php
7272
use DragonCode\LaravelDeployOperations\Operation;
7373

74-
return new class () extends Operation
74+
return new class extends Operation
7575
{
7676
public function __invoke(): void
7777
{
@@ -88,7 +88,7 @@ return new class () extends Operation
8888
```php
8989
use DragonCode\LaravelDeployOperations\Operation;
9090

91-
return new class () extends Operation
91+
return new class extends Operation
9292
{
9393
public function __invoke(): void {} // called when `php artisan operations` running
9494

@@ -105,7 +105,7 @@ You can also use the dependency injection with `__invoke`, `up` and `down` metho
105105
use DragonCode\LaravelDeployOperations\Operation;
106106
use Tests\Concerns\Some;
107107

108-
return new class () extends Operation
108+
return new class extends Operation
109109
{
110110
public function __invoke(Some $some): void
111111
{
@@ -118,7 +118,7 @@ return new class () extends Operation
118118
use DragonCode\LaravelDeployOperations\Operation;
119119
use Tests\Concerns\Some;
120120

121-
return new class () extends Operation
121+
return new class extends Operation
122122
{
123123
public function up(Some $some): void
124124
{

docs/how-to-use/rollback.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Rolling Back Operations
22

3-
To roll back the latest operation, you may use the `rollback` command. This command rolls back the last "batch" of actions, which may include multiple action files:
3+
To roll back the latest operation, you may use the `rollback` command. This command rolls back the last "batch" of operations, which may include multiple operation files:
44

55
```
66
php artisan operations:rollback
77
```
88

9-
You may roll back a limited number of operations by providing the `step` option to the rollback command. For example, the following command will roll back the last five actions:
9+
You may roll back a limited number of operations by providing the `step` option to the rollback command. For example, the following command will roll back the last five operations:
1010

1111
```
1212
php artisan operations:rollback --step=5
@@ -48,7 +48,7 @@ php artisan operations:rollback --step=2
4848

4949
## Roll Back & Operation Using A Single Command
5050

51-
The `operations:refresh` command will roll back all of your actions and then execute the `actions` command. This command effectively re-creates your entire
51+
The `operations:refresh` command will roll back all of your operations and then execute the `operations` command. This command effectively re-creates your entire
5252
database:
5353

5454
```
@@ -64,8 +64,8 @@ php artisan operations:refresh --step=5
6464

6565
## Drop All & Rerun Operations
6666

67-
The `operations:fresh` command will drop all operations records from the operations table and then execute the operations command:
67+
The `operations:fresh` command will drop all operation records from the operation table and then execute the operations command:
6868

6969
```
70-
php artisan actions:fresh
70+
php artisan operations:fresh
7171
```

docs/how-to-use/running.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -120,15 +120,15 @@ return new class extends Operation
120120

121121
If the value is `$once = false`, the `up` method will be called every time the `operations` command called.
122122

123-
In this case, information about it will not be written to the `actions` table and, therefore, the `down` method will not be called when the rollback command is called.
123+
In this case, information about it will not be written to the `operations` table and, therefore, the `down` method will not be called when the rollback command is called.
124124

125125
> Note
126126
>
127-
> When using the `before` parameter to run command, it is recommended to override the value of the `$before` attribute to `false`, otherwise this action will be executed twice.
127+
> When using the `before` parameter to run command, it is recommended to override the value of the `$before` attribute to `false`, otherwise this operation will be executed twice.
128128
129129
## Execution In A Specific Environment
130130

131-
In some cases, it becomes necessary to execute an action in a specific environment. For example `production`.
131+
In some cases, it becomes necessary to execute an operation in a specific environment. For example `production`.
132132

133133
For this you can use the `$environment` parameter:
134134

@@ -162,11 +162,11 @@ return new class extends Operation
162162
};
163163
```
164164

165-
By default, the action will run in all environments. The same will happen if you specify `null` or `[]` as the value.
165+
By default, the operation will run in all environments. The same will happen if you specify `null` or `[]` as the value.
166166

167167
## Execution Excluding Certain Environments
168168

169-
In some cases, it becomes necessary to execute an action excluding certain environments. For example `production`.
169+
In some cases, it becomes necessary to execute an operation excluding certain environments. For example `production`.
170170

171171
For this you can use the `$except_environment` parameter:
172172

@@ -200,15 +200,15 @@ return new class extends Operation
200200
};
201201
```
202202

203-
By default, no actions will be excluded. The same happens if you specify `null` or `[]` value.
203+
By default, no operations will be excluded. The same happens if you specify `null` or `[]` value.
204204

205205
## Database Transactions
206206

207-
In some cases, it becomes necessary to undo previously performed actions in the database. For example, when code execution throws an error. To do this, the code must be wrapped in
207+
In some cases, it becomes necessary to undo previously performed operations in the database. For example, when code execution throws an error. To do this, the code must be wrapped in
208208
a transaction.
209209

210210
By setting the `$transactions = true` parameter, you will ensure that your code is wrapped in a transaction without having to manually call the `DB::transaction()` method. This
211-
will reduce the time it takes to create the action.
211+
will reduce the time it takes to create the operation.
212212

213213
```php
214214
use DragonCode\LaravelDeployOperations\Operation;
@@ -228,9 +228,9 @@ return new class extends Operation
228228

229229
## Asynchronous Call
230230

231-
In some cases, it becomes necessary to execute actions in an asynchronous manner without delaying the deployment process.
231+
In some cases, it becomes necessary to execute operations in an asynchronous manner without delaying the deployment process.
232232

233-
To do this, you need to override the `$async` property in the action class:
233+
To do this, you need to override the `$async` property in the operation class:
234234

235235
```php
236236
use DragonCode\LaravelDeployOperations\Operation;
@@ -246,9 +246,9 @@ return new class extends Operation
246246
};
247247
```
248248

249-
In this case, the action file that defines this parameter will run asynchronously using the `DragonCode\LaravelDeployOperations\Jobs\ActionJob` class.
249+
In this case, the operation file that defines this parameter will run asynchronously using the `DragonCode\LaravelDeployOperations\Jobs\OperationJob` class.
250250

251-
The name of the connection and queue can be changed through the [settings](https://github.com/TheDragonCode/laravel-actions/tree/main/config).
251+
The name of the connection and queue can be changed through the [settings](https://github.com/TheDragonCode/laravel-deploy-operations/tree/main/config).
252252

253253
::: Info
254254
We remind you that in this case the [queuing system](https://laravel.com/docs/queues) must work in your application.

docs/prologue/upgrade-guide/3.x.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ class Some extends Actionable {}
8282
// after
8383
use DragonCode\LaravelActions\Action;
8484

85-
return new class () extends Action {};
85+
return new class extends Action {};
8686
```
8787

8888
## Invokable Method

docs/prologue/upgrade-guide/4.x.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Upgrading To 4.x from 3.x
22

3-
### High Impact Changes
3+
### High-Impact Changes
44

55
- [Rename package name](#rename-package-name)
66
- [Changing the names of console commands](#changing-the-names-of-console-commands)

0 commit comments

Comments
 (0)