Skip to content

Commit 73abeab

Browse files
committed
docs: fix typos, style issues
1 parent 4752786 commit 73abeab

File tree

11 files changed

+22
-23
lines changed

11 files changed

+22
-23
lines changed

docs/src/api/process.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ For simple user interaction with flows that include forms, a process can also be
3333
started [in a browser directly](#browser) and therefore via a link e.g. in an
3434
email or online documentation or even any web applicaion.
3535

36-
Following is the full information about the API. It allows the user
37-
to starts a new process using the provided files as request data.
36+
The following provides complete API information. It allows users
37+
to start a new process using the provided files as request data.
3838
Accepts multiple additional files, which are put into the process'
3939
working directory.
4040

docs/src/api/repository.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ parameters.
8282

8383
## Delete a Repository
8484

85-
A DELETE request can be used to removes a repository.
85+
A DELETE request can be used to remove a repository.
8686

8787
* **URI** `/api/v1/org/{orgName}/project/{projectName}/repository/{repositoryName}`
8888
* **Method** `DELETE`

docs/src/api/secret.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ generates the new key pair and returns the public key:
101101
}
102102
```
103103
104-
This key can be used a deploy key in the git repository of your project to
104+
This key can be used as a deploy key in the git repository of your project to
105105
establish the necessary trust between the Concord server and your git repository
106106
hosting system.
107107
@@ -193,7 +193,7 @@ Updates parameters of an existing secret.
193193
- `type=data`:
194194
- `data` - a string or binary value(file).
195195
196-
`storePassword` should be mandatory to update a password protected secret.
196+
`storePassword` is required to update a password-protected secret.
197197
198198
* **Success response**
199199
```
@@ -453,7 +453,7 @@ Moves the Secret to the specified Organization (through Organization name ID)
453453
* **Headers** `Authorization`, `Content-Type: application/json`
454454
* **Body**
455455
```
456-
Content-Tupe: application/json
456+
Content-Type: application/json
457457
```
458458
459459
```json

docs/src/api/team.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Updates parameters of an existing team.
8181
}
8282
```
8383

84-
<a name="list-teams">
84+
<a name="list-teams"/>
8585
## List Teams
8686

8787
Lists all existing teams.

docs/src/api/template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Template
22

33
[Templates](../templates/index.md) allows sharing of common elements and
4-
process.
4+
processes.
55

66
The REST API provides support for a number of operations:
77

@@ -60,7 +60,7 @@ Lists existing template aliases.
6060
]
6161
```
6262

63-
<a name="delete-template-alias"
63+
<a name="delete-template-alias"/>
6464
## Delete a Template Alias
6565

6666
Removes an existing template alias.

docs/src/api/user.md

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

33
A user represents an actual person using Concord to execute processes or
4-
adminstrate the server.
4+
administer the server.
55

66
The REST API provides support for a number of operations:
77

@@ -45,7 +45,7 @@ using the specified username.
4545
}
4646
```
4747

48-
The `created` paratemer indicates whether the user was created or updated.
48+
The `created` parameter indicates whether the user was created or updated.
4949

5050
<a name="find-user"/>
5151

@@ -67,11 +67,10 @@ Find an existing user by name.
6767
{
6868
"id" : "...",
6969
"name" : "myUser"
70-
7170
}
7271
```
7372

74-
The `created` paratemer indicates whether the user was created or updated.
73+
The `created` parameter indicates whether the user was created or updated.
7574

7675
<a name="sync-ldap-groups-user"/>
7776

@@ -102,4 +101,4 @@ Synchronize LDAP groups for a given user.
102101
```
103102

104103
The `UPDATED` result indicates the ldap groups for a specified username got synced successfully.
105-
<p><strong>Note</strong>: Only administrators(role: concordAdmin) can synchronize user LDAP groups</p>
104+
<p><strong>Note</strong>: Only administrators (role: concordAdmin) can synchronize user LDAP groups</p>

docs/src/getting-started/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ A process can run in a [project](#projects), thus sharing configuration and
1919
resources (such as [the KV store]({{ site.concord_plugins_v2_docs }}/key-value.md)) with other
2020
processes in the same project.
2121

22-
Processes can be suspended (typically using a [form](./forms.md) and resumed.
22+
Processes can be suspended (typically using a [form](./forms.md)) and resumed.
2323
While suspended processes are not consuming any resources apart from the DB
2424
disk space. See the [Process Overview](../processes-v2/index.md) section for
2525
more details about the lifecycle of Concord processes.
@@ -48,7 +48,7 @@ resources.
4848

4949
## Organizations
5050

51-
Organizations are, basically, namespaces to which resources such as projects,
51+
Organizations are essentially namespaces to which resources such as projects,
5252
secrets, teams and others belong to.
5353

5454
# Components

docs/src/getting-started/quickstart.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ execution with a few simple steps:
1313

1414
<a name="create-repository"/>
1515

16-
## Create Git Repository
16+
## Create a Git Repository
1717

1818
Concord process definitions and their resources are best managed and source
1919
controlled in a Git repository. Concord can automatically retrieve the contents
@@ -22,7 +22,7 @@ the content.
2222

2323
Start with the following steps:
2424

25-
- Create the repository in your Git management sytem, such as GitHub, using the
25+
- Create the repository in your Git management system, such as GitHub, using the
2626
user interface;
2727
- Clone the repository to your local workstation.
2828

@@ -102,7 +102,7 @@ Everything is ready to kick off an execution of the flow - a process:
102102
- Press on the _Run_ button;
103103
- Confirm to start the process by clicking on _Yes_ in the dialog;
104104

105-
A successful process execution results a message such as:
105+
A successful process execution results in a message such as:
106106

107107
```
108108
{

docs/src/processes-v2/flows.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ flows:
255255
```
256256

257257
- `isDebug` - returns `true` if process started with debug flag;
258-
- `isDryRun` - returns `true` if process stated in dry-run mode;
258+
- `isDryRun` - returns `true` if the process was started in dry-run mode;
259259

260260
- `orDefault` - accepts a variable name (as a string parameter), default value and
261261
returns variable value or default value;
@@ -1024,7 +1024,7 @@ Retry flow call:
10241024
The default `in` and `retry` variables with the same values are overwritten.
10251025

10261026
In the example below the value of `someVar` is overwritten to 321 in the
1027-
`retry` block..
1027+
`retry` block.
10281028

10291029

10301030
```yaml

docs/src/processes-v2/imports.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ imports:
4040
options
4141
```
4242

43-
Note, that `imports` is a top-level objects, similar to `configuration`.
43+
Note that `imports` is a top-level object, similar to `configuration`.
4444
In addition, only the main YAML file's, the root `concord.yml`, `imports` are
4545
allowed.
4646

0 commit comments

Comments
 (0)