Skip to content

Commit 55e4c2c

Browse files
committed
Update documentation
1 parent 0e4815a commit 55e4c2c

File tree

7 files changed

+39
-58
lines changed

7 files changed

+39
-58
lines changed

Documentation/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ home: true
33
editLink: false
44
heroImage: /neos-backups.svg
55
heroText: Neos Backups
6-
tagline: Easy backup and restore your Neos CMS in different filesystems
6+
tagline: Easily backup and restore your Neos CMS in different file systems
77
actionText: Get Started →
88
actionLink: /installation
99
features:
10-
- title: Easy customizable
11-
details: You can easily add your own backup steps or add your own filesystem adapter.
10+
- title: Easily customizable
11+
details: You can easily add your own backup steps or add your own file system adapter.
1212
- title: Easy to use
13-
details: Everything is ready to use. For a normal backup you dont have to write a single line of code.
13+
details: Everything is ready to use. For a normal backup you don't have to write a single line of code.
1414
- title: Open Source
15-
details: Its free, why not use it? Its always better to have backups.
15+
details: It's free, why not use it? It's always better to have backups.
1616
footer: GPL-3.0 Licensed | Copyright © 2020 by Marvin Kuhn
1717
---

Documentation/commands.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## `backup:list`
44

5-
Lists backups available.
5+
Lists all available backups.
66

77
```bash
88
./flow backup:list
@@ -13,7 +13,7 @@ Lists backups available.
1313
The index where this command should start listing
1414

1515
`--limit` <br />
16-
The number of backups shown
16+
The number of backups to show
1717

1818

1919
## `backup:create`
@@ -27,42 +27,42 @@ Creates a single backup.
2727

2828
## `backup:restore`
2929

30-
Restores a single backup.
30+
Restores a single backup by name.
3131

3232
```bash
3333
./flow backup:restore <name>
3434
```
3535

3636
#### Options
3737
`--no-confirm` <br />
38-
If this flag is set, you dont have to confirm this action by pressing <kbd>Y</kbd> + <kbd>Return</kbd>.
38+
If this flag is set, you don't have to confirm this action by pressing <kbd>Y</kbd> + <kbd>Return</kbd>.
3939

4040

4141
## `backup:delete`
4242

43-
Deletes a single backup.
43+
Deletes a single backup by name.
4444

4545
```bash
4646
./flow backup:delete <name>
4747
```
4848

4949
#### Options
5050
`--no-confirm` <br />
51-
If this flag is set, you dont have to confirm this action by pressing <kbd>Y</kbd> + <kbd>Return</kbd>.
51+
If this flag is set, you don't have to confirm this action by pressing <kbd>Y</kbd> + <kbd>Return</kbd>.
5252

5353

5454

5555
## `backup:prune`
5656

57-
Deletes all backups, but you can keep the latest X Backups with the `--keep` option.
57+
Deletes all current backups.
5858

5959
```bash
6060
./flow backup:prune
6161
```
6262

6363
#### Options
6464
`--no-confirm` <br />
65-
If this flag is set, you dont have to confirm this action by pressing <kbd>Y</kbd> + <kbd>Return</kbd>.
65+
If this flag is set, you don't have to confirm this action by pressing <kbd>Y</kbd> + <kbd>Return</kbd>.
6666

6767
`--keep x` <br />
68-
Keep the latest X Backups
68+
Keeps the latest x backups

Documentation/custom-behaviours.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ class MyCustomExportStep extends StepAbstract
2525

2626
/**
2727
* your restore warning markdown string
28-
* if a this property is not sufficient,
28+
* if this property is not sufficient,
2929
* you can override the getRestoreWarning() method
3030
*
3131
* @var string

Documentation/filesystems.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Filesystems
1+
# File systems
22

3-
This package provides the following filesystem adapter by default:
3+
This package provides the following file system adapters by default:
44

55
* [Local](#local)
66
* [SFTP](#sftp)

Documentation/installation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Installation
22

3-
You can easly add this package via composer. Check the requirements and run the command below.
3+
You can easily add this package via composer. Check the requirements and run the command below.
44

55
**Requirements:**
66
- PHP <= 7.1
@@ -14,10 +14,10 @@ composer require breadlesscode/neos-backups
1414

1515
## Setup configuration
1616

17-
First you have to choose a [filesystem](./filesystems.md) where you want to store the backups.
18-
Than you have to configure all backup steps you want to use.
17+
First you have to choose a [file system](./filesystems.md) where you want to store the backups.
18+
Then you have to configure which backup steps you want to use.
1919

20-
Example Configuration:
20+
Example configuration:
2121
```yaml
2222
Breadlesscode:
2323
Backups:

Documentation/steps.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Backup Steps
1+
# Backup steps
22

33
* [File/Directory copy step](#file-directory-copy-step)
44
* [Site export step](#site-export-step)
5-
* [MySql-Table export step](#mysql-table-export-step)
5+
* [MySQL table export step](#mysql-table-export-step)
66

77

88
## File export step
9-
This is a easy step to copy files and directories into the backup.
9+
This is an easy step to copy files and directories into the backup.
1010

1111
Example configuration:
1212
```yaml
@@ -19,8 +19,8 @@ Breadlesscode:
1919
```
2020
2121
## Site export step
22-
This step uses the Neos CMS site export functionality to export sites and his resources
23-
into a XML-File.
22+
This step uses the Neos CMS site export functionality to export sites and its resources
23+
into an XML-File.
2424
2525
Example configuration:
2626
```yaml
@@ -30,9 +30,9 @@ Breadlesscode:
3030
'Breadlesscode\Backups\Step\SiteExportStep': []
3131
```
3232
33-
## MySql-Table export step
33+
## MySQL table export step
3434
35-
This step exports MySql-Tables via the `mysqldump`-Binary.
35+
This step exports MySQL tables via the `mysqldump` binary.
3636

3737
Example configuration:
3838
```yaml

package-lock.json

Lines changed: 11 additions & 30 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)