Skip to content

Commit a864790

Browse files
authored
Fix typos in README (#21)
1 parent c801828 commit a864790

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Studion Platform common infra components.
1212
## Prerequisites
1313

1414
- Working [Pulumi](https://www.pulumi.com/docs/clouds/aws/get-started/begin/#pulumi-aws-before-you-begin) project
15-
- AWS account with neccessary permissions for each studion component
15+
- AWS account with necessary permissions for each Studion component
1616

1717
## Installation
1818

@@ -48,7 +48,7 @@ const project = new studion.Project('demo-project', {
4848
export const projectName = project.name;
4949
```
5050

51-
- Deploy pulumi stack
51+
- Deploy Pulumi stack
5252

5353
```bash
5454
$ pulumi up
@@ -71,7 +71,7 @@ $ pulumi up
7171
Project component makes it really easy to spin up project infrastructure,
7272
hiding infrastructure complexity.
7373
<br>
74-
The component creates its own VPC which is used for resources within the project.
74+
The component creates its own VPC used for resources within the project.
7575

7676
```ts
7777
new Project(name: string, args: ProjectArgs, opts?: pulumi.CustomResourceOptions);
@@ -102,7 +102,7 @@ type ProjectArgs = {
102102
| Argument | Description |
103103
| :--------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------: |
104104
| services \* | Service list. |
105-
| enableSSMConnect | Setup ec2 instance and SSM in order to connect to the database in the private subnet. Please refer to the [SSM Connect](#ssm-connect) section for more info. |
105+
| enableSSMConnect | Set up ec2 instance and SSM in order to connect to the database in the private subnet. Please refer to the [SSM Connect](#ssm-connect) section for more info. |
106106
| numberOfAvailabilityZones | Default is 2 which is recommended. If building a dev server, we can reduce to 1 availability zone to reduce hosting cost. |
107107

108108
```ts
@@ -257,7 +257,7 @@ type EcsServiceOptions = {
257257

258258
Often, web server depends on other services such as database, Redis, etc.
259259
For that purpose, environment factory can be used. The factory function
260-
recieves services bag as argument.
260+
receives services bag as argument.
261261

262262
```ts
263263
const project = new studion.Project('demo-project', {
@@ -287,7 +287,7 @@ const project = new studion.Project('demo-project', {
287287
});
288288
```
289289

290-
In order to pass sensitive information to the container use `secrets` instead of `environment`. AWS will fetch values from
290+
In order to pass sensitive information to the container, use `secrets` instead of `environment`. AWS will fetch values from
291291
Secret Manager based on arn that is provided for the `valueFrom` field.
292292

293293
```ts
@@ -379,7 +379,7 @@ type DatabaseArgs = {
379379
};
380380
```
381381

382-
If the password is not specified it will be autogenerated.
382+
If the password is not specified, it will be autogenerated.
383383
The database password is stored as a secret inside AWS Secret Manager.
384384
The secret will be available on the `Database` resource as `password.secret`.
385385

@@ -518,7 +518,7 @@ Features:
518518
- creates TLS certificate for the specified domain
519519
- redirects HTTP traffic to HTTPS
520520
- creates CloudWatch log group
521-
- comes with predefined cpu and memory options: `small`, `medium`, `large`, `xlarge`
521+
- comes with predefined CPU and memory options: `small`, `medium`, `large`, `xlarge`
522522

523523
<br>
524524

@@ -573,7 +573,7 @@ Features:
573573
- creates TLS certificate for the specified domain
574574
- redirects HTTP traffic to HTTPS
575575
- creates CloudWatch log group
576-
- comes with predefined cpu and memory options: `small`, `medium`, `large`, `xlarge`
576+
- comes with predefined CPU and memory options: `small`, `medium`, `large`, `xlarge`
577577
- CDN in front of the application load balancer for static resource caching
578578

579579
<br>
@@ -624,7 +624,7 @@ Features:
624624
- persistent storage
625625
- service auto-discovery
626626
- creates CloudWatch log group
627-
- comes with predefined cpu and memory options: `small`, `medium`, `large`, `xlarge`
627+
- comes with predefined CPU and memory options: `small`, `medium`, `large`, `xlarge`
628628

629629
<br>
630630

@@ -656,7 +656,7 @@ export type MongoArgs = {
656656
```
657657

658658
If the password is not specified it will be autogenerated.
659-
The mongo password is stored as a secret inside AWS Secret Manager.
659+
The Mongo password is stored as a secret inside AWS Secret Manager.
660660
The secret will be available on the `Mongo` resource as `password.secret`.
661661

662662
### Ecs Service
@@ -666,7 +666,7 @@ AWS ECS Fargate.
666666
Features:
667667

668668
- memory and CPU autoscaling
669-
- service auto discovery
669+
- service auto-discovery
670670
- persistent storage
671671
- CloudWatch logs
672672
- comes with predefined cpu and memory options: `small`, `medium`, `large`, `xlarge`
@@ -747,7 +747,7 @@ Where `CLUSTER_NAME` is the name of the ECS cluster and `TASK_FAMILY_NAME` is th
747747

748748
## SSM Connect
749749

750-
The [Database](#database) component deploys a database instance inside a isolated subnet,
750+
The [Database](#database) component deploys a database instance inside an isolated subnet,
751751
and it's not publicly accessible from outside of VPC.
752752
<br>
753753
In order to connect to the database we need to deploy the ec2 instance which will be used
@@ -796,7 +796,7 @@ Now you can use your favorite database client to connect to the database.
796796
![RDS connection](/assets/images/rds-connection.png)
797797

798798
It is important that for the host you set `localhost` and for the port you set `5555`
799-
because we are port forwarding traffic from
799+
because we are port-forwarding traffic from
800800
localhost:5555 to DATABASE_ADDRESS:DATABASE_PORT.
801801
For the user, password, and database field, set values which are set in the `Project`.
802802

0 commit comments

Comments
 (0)