Skip to content

Commit 1f5cfb2

Browse files
authored
Documentation edits (#3417)
* Add "a" to sentence * Altered sentence structure * Altered paragraph slightly * Joined sentences in paragraph * Added few words to paragraph * Remove brackets. Make a new sentence * Alter sentence * Add "the"
1 parent 1da73c2 commit 1f5cfb2

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

docs/getting-started.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -35,32 +35,31 @@ Configure Reverse DNS or RDNS on your server. This will allow you to ssh into
3535
server using the domain name instead of the IP address.
3636
:::
3737

38-
Our **deploy.php** recipe contains host definition with few important params:
38+
Our **deploy.php** recipe contains a host definition with few important params:
3939

4040
- `remote_user` user's name for ssh connection,
4141
- `deploy_path` host's path where we are going to deploy.
4242

43-
Let's set `remote_user` to be `deployer`. Right now our new server probably has
44-
only `root` user. The provision recipe will create and configure `deployer` user
45-
for us.
43+
Let's set `remote_user` to be `deployer`. Right now our new server probably only has the `root` user. The provision recipe will
44+
create and configure a `deployer` user for us.
4645

4746
```php
4847
host('example.org')
4948
->set('remote_user', 'deployer')
5049
->set('deploy_path', '~/example');
5150
```
5251

53-
To connect to remote host we need to specify identity key or private key.
54-
We can add our identity key directly into host definition, but better to put it
55-
in **~/.ssh/config** file:
52+
To connect to the remote host we need to specify an identity key or private key.
53+
We can add our identity key directly into the host definition, but it's better to put it
54+
in the **~/.ssh/config** file:
5655

5756
```
5857
Host *
5958
IdentityFile ~/.ssh/id_rsa
6059
```
6160

62-
Now let's provision our server. As our host doesn't have user `deployer`.
63-
We are going to override `remote_user` for provision via `-o remote_user=root`.
61+
Now let's provision our server. As our host doesn't have user `deployer`,
62+
we are going to override `remote_user` for provision via `-o remote_user=root`.
6463

6564
```sh
6665
dep provision -o remote_user=root
@@ -92,8 +91,8 @@ To deploy the project:
9291
dep deploy
9392
```
9493

95-
If deploy failed, Deployer will print error message and command what was unsuccessful.
96-
Most likely we need to configure correct database credentials in _.env_ file or similar.
94+
If deploy failed, Deployer will print an error message and which command was unsuccessful.
95+
Most likely we need to configure the correct database credentials in _.env_ file or similar.
9796

9897
Ssh to the host, for example, for editing _.env_ file:
9998

@@ -102,13 +101,13 @@ dep ssh
102101
```
103102

104103
After everything is configured properly we can resume our deployment from the
105-
place it stopped (But this is not required, we can just start a new deploy):
104+
place it stopped. However, this is not required; we can just start a new deploy:
106105

107106
```
108107
dep deploy --start-from deploy:migrate
109108
```
110109

111-
After our first successful deployment, we can find next structure on our server:
110+
After our first successful deployment, we can find the following directory structure on our server:
112111

113112
```
114113
~/example // The deploy_path.
@@ -133,7 +132,7 @@ location / {
133132
}
134133
```
135134

136-
If you're using provision recipe, Deployer will automatically configure Caddy
135+
If you're using provision recipe, Deployer will automatically configure the Caddy
137136
webserver to serve from the [public_path](/docs/recipe/provision/website.md#public_path).
138137

139138
Now let's add a build step on our host:

0 commit comments

Comments
 (0)