Skip to content

Commit c6f852f

Browse files
doc typos
Signed-off-by: Laurent Martin <laurent.martin.l@gmail.com>
1 parent c2b4814 commit c6f852f

File tree

2 files changed

+42
-38
lines changed

2 files changed

+42
-38
lines changed

docs/README.erb.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -249,8 +249,8 @@ There are several ways to install <%=tool%>:
249249

250250
The following sections describe the various installation methods.
251251

252-
An internet connection is required for the installation.
253-
If you do not have internet access, refer to section [Installation without internet access](#installation-in-air-gapped-environment).
252+
An internet connection is required during installation.
253+
If you do not have internet access, refer to section [Installation without internet access](#installation-in-an-air-gapped-environment).
254254

255255
### Single file executable
256256

@@ -277,7 +277,7 @@ chmod a+x <%=cmd%>
277277

278278
> [!WARNING]
279279
> On Linux, the executable requires a minimum GLIBC version, specified in the executable name on download site.
280-
> If the minimuim version is not met, then executables (`ascp`, `transferd`) will exit with error.
280+
> If the minimum version is not met, then executables (`ascp`, `transferd`) will exit with error.
281281
282282
On Linux, you can check your system's GLIBC version on this site: [repology.org](https://repology.org/project/glibc/versions), or check your GLIBC version with `ldd`:
283283

@@ -585,7 +585,7 @@ JRUBY_OPTS=--dev <%=cmd%> -v
585585
#### Optional gems
586586

587587
Some additional gems are required for either development, or some runtime specific features.
588-
For JRuby, some replacement gems are proposed, or are nor available at all.
588+
For JRuby, some replacement gems are proposed, or are not available at all.
589589
Those are not installed as part of dependencies because they involve compilation of native code but concern less-used features.
590590

591591
See [Gemfile](<%=link_repo('Gemfile')%>):
@@ -742,7 +742,7 @@ Several methods are provided to start a transfer.
742742
Use of a local client ([`direct`](#agent-direct) transfer agent) is one of them, but other methods are available.
743743
Refer to section: [Transfer Agents](#transfer-clients-agents)
744744

745-
### Installation in air gapped environment
745+
### Installation in an air-gapped environment
746746

747747
> [!NOTE]
748748
> No pre-packaged version is provided yet.
@@ -925,8 +925,8 @@ As shown in the quick start, if you prefer to keep a running container with a sh
925925
> <%=tool%> is run inside the container, so transfers are also executed inside the container and do not have access to host storage by default.
926926
927927
You may also probably want that files downloaded in the container are directed to the host.
928-
For example, files transfered with <%=tool%> through folder `/xferfiles` (right hand side) would be available on host in `$HOME/xferdir`.
929-
In this case you need also to specify the shared transfer folder as a volume:
928+
For example, files transferred with <%=tool%> through folder `/xferfiles` (right hand side) would be available on host in `$HOME/xferdir`.
929+
In this case you also need to specify the shared transfer folder as a volume:
930930

931931
```shell
932932
--volume $HOME/xferdir:/xferfiles
@@ -1616,7 +1616,7 @@ In those cases, there is no character to protect because values are not parsed b
16161616
### Positional Arguments and Options
16171617

16181618
Command line arguments are the units of command line typically separated by spaces (the `argv` of C).
1619-
The tokenization of the command line is typically done by the shell, refer to the previous section [Command Line Parsing](#command-line-parsing-special-characters).
1619+
Command line tokenization is typically performed by the shell, refer to the previous section [Command Line Parsing](#command-line-parsing-special-characters).
16201620

16211621
<%=tool%> handles two types of command line arguments:
16221622

@@ -3011,7 +3011,7 @@ mv ${KEY_PAIR_PATH}.with_des ${KEY_PAIR_PATH}
30113011

30123012
#### Using an application to generate a key pair
30133013

3014-
Many applications are available, including on internet, to generate key pairs.
3014+
Many applications are available, including on the internet, to generate key pairs.
30153015
For example: <https://cryptotools.net/rsagen>
30163016

30173017
> [!WARNING]
@@ -3020,7 +3020,7 @@ For example: <https://cryptotools.net/rsagen>
30203020
### Web service
30213021

30223022
Some plugins start a local web server.
3023-
This server can server HTTP or HTTPS (with certificate):
3023+
This server can serve HTTP or HTTPS (with certificate):
30243024

30253025
The following parameters are supported:
30263026

@@ -3191,7 +3191,7 @@ HTTP connection parameters (not `ascp` WSS) can be adjusted using option `http_o
31913191
| `token_cache_max_age` | `Integer` | `1800` | `OAuth` class |
31923192
| `token_refresh_threshold` | `Integer` | `120` | `OAuth` class |
31933193

3194-
Time values are in set **seconds** and can be of type either `Integer` or `Float`.
3194+
Time values are set in **seconds** and can be of type either `Integer` or `Float`.
31953195
Default values are the ones of Ruby:
31963196
For a full list, refer to the Ruby library: [`Net::HTTP`](https://github.com/ruby/net-http/blob/master/lib/net/http.rb).
31973197

@@ -3337,7 +3337,7 @@ It provides the following commands for `ascp` sub-command:
33373337
- `show` : shows the path of `ascp` used
33383338
- `use` : specify the `ascp` path to use
33393339
- `products` : list Aspera transfer products available locally
3340-
- `connect` : list and download connect client versions available on internet
3340+
- `connect` : list and download connect client versions available on the internet
33413341

33423342
#### Selection of `ascp` location for [`direct`](#agent-direct) agent
33433343

@@ -4992,7 +4992,7 @@ The following parameters are supported:
49924992
| `pmax` | <%=tool%> | Maximum number of pages to request. |
49934993
| other | Native | Other specific parameters depending on resource type. |
49944994
4995-
> [!INFO]
4995+
> [!NOTE]
49964996
> Both `max` and `pmax` are processed internally in <%=tool%>, not included in actual API call and limit the number of successive pages requested to API.
49974997
> <%=tool%> will return all values using paging if not provided.
49984998
> `page` and `per_page` are normally added by <%=tool%> to build successive API calls to get all values if there are more than 1000.
@@ -5143,7 +5143,7 @@ Refer to section **Examples** of [ATS](#plugin-ats-ibm-aspera-transfer-service)
51435143
Aspera on Cloud Shared folders are implemented through a special type of file: `link`.
51445144
A `link` is the equivalent of a symbolic link on a file system: it points to another folder (not file).
51455145
5146-
Listing a link (in terminal position of path) will information on the link itself, not the content of the folder it points to.
5146+
Listing a link (in terminal position of path) will show information on the link itself, not the content of the folder it points to.
51475147
To list the target folder content, add a `/` at the end of the path.
51485148
51495149
Example:
@@ -5217,7 +5217,7 @@ Current Workspace: Default (default)
52175217
+-------+---------+
52185218
```
52195219
5220-
#### Example: Find deactivated users since more than 2 years
5220+
#### Example: Find deactivated users for more than 2 years
52215221
52225222
```shell
52235223
<%=cmd%> aoc admin user list --query=@ruby:'{"deactivated"=>true,"q"=>"last_login_at:<#{(DateTime.now.to_time.utc-2*365*86400).iso8601}"}'
@@ -6473,7 +6473,7 @@ Option `node_api` (`Hash`) controls some options of API used, with the following
64736473
64746474
| Parameter| Default | Description |
64756475
|----------|---------|-------------|
6476-
| `cache` | `true` | `true` Folder content retrieved from Redis database (faster).<%=br%>`false` Folder content retrieved from storage. |
6476+
| `cache` | `true` | `true` Folder content is retrieved from the Redis database (faster).<%=br%>`false` Folder content retrieved from storage. |
64776477
| `standard_ports` | `true` | `true` Use hard coded standard ports (`33001`)<%=br%>`false` Retrieve server ports from an API call (`download_setup`) which reads the information from `aspera.conf` on the server. |
64786478
| `accept_v4` | `true` | `true` (default) uses API header: `Accept-Version: 4.0`.<%=br%>`false` uses legacy method (refer to node API). |
64796479
| `per_page` | - | Requested number of items per API call.<%=br%>Set to `nil` (`@none:`) to deactivate paging.<%=br%>Default: `1000` when `accept_v4` is `true`. |
@@ -7079,7 +7079,7 @@ The user will use the following options:
70797079
70807080
### Faspex 5 public link authentication
70817081
7082-
If all you have is a public link received by email or other, you can still do authorized actins with it.
7082+
If all you have is a public link received by email or other, you can still do authorized actions with it.
70837083
70847084
For example, for a public link to post a package:
70857085
@@ -8218,7 +8218,9 @@ If the preview generator does not have access to files on the file system (it is
82188218
82198219
## Operational Utilities
82208220
8221-
This section covers the specialized modules and utilities used to integrate <%=tool%> into your broader operational infrastructure. While the core plugins handle data movement, these tools provide the "connective tissue" for enterprise environments: Aspera Sync and Hot Folder enable automated, folder-based synchronization; Nagios and SMTP modules provide health monitoring and automated email alerting for transfer status; and `asession` and module manage internal session states and environment configurations. Together, these features transform the CLI from a manual tool into a fully integrated component of an automated, monitored data workflow.
8221+
This section covers the specialized modules and utilities used to integrate <%=tool%> into your broader operational infrastructure.
8222+
While the core plugins handle data movement, these tools provide the "integration layer" for enterprise environments: Aspera Sync and Hot Folder enable automated, folder-based synchronization; Nagios and SMTP modules provide health monitoring and automated email alerting for transfer status; and `asession` and module manage internal session states and environment configurations.
8223+
Together, these features transform the CLI from a manual tool into a fully integrated component of an automated, monitored data workflow.
82228224
82238225
### IBM Aspera Sync
82248226
@@ -8420,7 +8422,7 @@ Interesting `ascp` features are found in its arguments: (see `ascp` manual):
84208422
- Send only files not modified since the last X seconds:
84218423
- `--exclude-newer-than` (`exclude_newer_than`)
84228424
- `--exclude-older-than` (`exclude_older_than`)
8423-
- Top level folder shall not be created on destination
8425+
- Top level folder should not be created on destination
84248426
- `--src-base` (`src_base`)
84258427
84268428
> [!NOTE]

docs/README.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -250,8 +250,8 @@ There are several ways to install `ascli`:
250250

251251
The following sections describe the various installation methods.
252252

253-
An internet connection is required for the installation.
254-
If you do not have internet access, refer to section [Installation without internet access](#installation-in-air-gapped-environment).
253+
An internet connection is required during installation.
254+
If you do not have internet access, refer to section [Installation without internet access](#installation-in-an-air-gapped-environment).
255255

256256
### Single file executable
257257

@@ -278,7 +278,7 @@ chmod a+x ascli
278278

279279
> [!WARNING]
280280
> On Linux, the executable requires a minimum GLIBC version, specified in the executable name on download site.
281-
> If the minimuim version is not met, then executables (`ascp`, `transferd`) will exit with error.
281+
> If the minimum version is not met, then executables (`ascp`, `transferd`) will exit with error.
282282
283283
On Linux, you can check your system's GLIBC version on this site: [repology.org](https://repology.org/project/glibc/versions), or check your GLIBC version with `ldd`:
284284

@@ -589,7 +589,7 @@ JRUBY_OPTS=--dev ascli -v
589589
#### Optional gems
590590

591591
Some additional gems are required for either development, or some runtime specific features.
592-
For JRuby, some replacement gems are proposed, or are nor available at all.
592+
For JRuby, some replacement gems are proposed, or are not available at all.
593593
Those are not installed as part of dependencies because they involve compilation of native code but concern less-used features.
594594

595595
See [Gemfile](../Gemfile):
@@ -790,7 +790,7 @@ Several methods are provided to start a transfer.
790790
Use of a local client ([`direct`](#agent-direct) transfer agent) is one of them, but other methods are available.
791791
Refer to section: [Transfer Agents](#transfer-clients-agents)
792792

793-
### Installation in air gapped environment
793+
### Installation in an air-gapped environment
794794

795795
> [!NOTE]
796796
> No pre-packaged version is provided yet.
@@ -973,8 +973,8 @@ As shown in the quick start, if you prefer to keep a running container with a sh
973973
> `ascli` is run inside the container, so transfers are also executed inside the container and do not have access to host storage by default.
974974
975975
You may also probably want that files downloaded in the container are directed to the host.
976-
For example, files transfered with `ascli` through folder `/xferfiles` (right hand side) would be available on host in `$HOME/xferdir`.
977-
In this case you need also to specify the shared transfer folder as a volume:
976+
For example, files transferred with `ascli` through folder `/xferfiles` (right hand side) would be available on host in `$HOME/xferdir`.
977+
In this case you also need to specify the shared transfer folder as a volume:
978978

979979
```shell
980980
--volume $HOME/xferdir:/xferfiles
@@ -1664,7 +1664,7 @@ ascli config echo @ruby:"{'title'=>ENV['MYTITLE']}" --format=json
16641664
### Positional Arguments and Options
16651665

16661666
Command line arguments are the units of command line typically separated by spaces (the `argv` of C).
1667-
The tokenization of the command line is typically done by the shell, refer to the previous section [Command Line Parsing](#command-line-parsing-special-characters).
1667+
Command line tokenization is typically performed by the shell, refer to the previous section [Command Line Parsing](#command-line-parsing-special-characters).
16681668

16691669
`ascli` handles two types of command line arguments:
16701670

@@ -3167,7 +3167,7 @@ mv ${KEY_PAIR_PATH}.with_des ${KEY_PAIR_PATH}
31673167

31683168
#### Using an application to generate a key pair
31693169

3170-
Many applications are available, including on internet, to generate key pairs.
3170+
Many applications are available, including on the internet, to generate key pairs.
31713171
For example: <https://cryptotools.net/rsagen>
31723172

31733173
> [!WARNING]
@@ -3176,7 +3176,7 @@ For example: <https://cryptotools.net/rsagen>
31763176
### Web service
31773177

31783178
Some plugins start a local web server.
3179-
This server can server HTTP or HTTPS (with certificate):
3179+
This server can serve HTTP or HTTPS (with certificate):
31803180

31813181
The following parameters are supported:
31823182

@@ -3347,7 +3347,7 @@ HTTP connection parameters (not `ascp` WSS) can be adjusted using option `http_o
33473347
| `token_cache_max_age` | `Integer` | `1800` | `OAuth` class |
33483348
| `token_refresh_threshold` | `Integer` | `120` | `OAuth` class |
33493349

3350-
Time values are in set **seconds** and can be of type either `Integer` or `Float`.
3350+
Time values are set in **seconds** and can be of type either `Integer` or `Float`.
33513351
Default values are the ones of Ruby:
33523352
For a full list, refer to the Ruby library: [`Net::HTTP`](https://github.com/ruby/net-http/blob/master/lib/net/http.rb).
33533353

@@ -3493,7 +3493,7 @@ It provides the following commands for `ascp` sub-command:
34933493
- `show` : shows the path of `ascp` used
34943494
- `use` : specify the `ascp` path to use
34953495
- `products` : list Aspera transfer products available locally
3496-
- `connect` : list and download connect client versions available on internet
3496+
- `connect` : list and download connect client versions available on the internet
34973497

34983498
#### Selection of `ascp` location for [`direct`](#agent-direct) agent
34993499

@@ -5531,7 +5531,7 @@ The following parameters are supported:
55315531
| `pmax` | `ascli` | Maximum number of pages to request. |
55325532
| other | Native | Other specific parameters depending on resource type. |
55335533
5534-
> [!INFO]
5534+
> [!NOTE]
55355535
> Both `max` and `pmax` are processed internally in `ascli`, not included in actual API call and limit the number of successive pages requested to API.
55365536
> `ascli` will return all values using paging if not provided.
55375537
> `page` and `per_page` are normally added by `ascli` to build successive API calls to get all values if there are more than 1000.
@@ -5682,7 +5682,7 @@ Refer to section **Examples** of [ATS](#plugin-ats-ibm-aspera-transfer-service)
56825682
Aspera on Cloud Shared folders are implemented through a special type of file: `link`.
56835683
A `link` is the equivalent of a symbolic link on a file system: it points to another folder (not file).
56845684
5685-
Listing a link (in terminal position of path) will information on the link itself, not the content of the folder it points to.
5685+
Listing a link (in terminal position of path) will show information on the link itself, not the content of the folder it points to.
56865686
To list the target folder content, add a `/` at the end of the path.
56875687
56885688
Example:
@@ -5756,7 +5756,7 @@ ascli aoc admin user list --query='@json:{"q":"dummyuser"}' --fields=id --displa
57565756
+-------+---------+
57575757
```
57585758
5759-
#### Example: Find deactivated users since more than 2 years
5759+
#### Example: Find deactivated users for more than 2 years
57605760
57615761
```shell
57625762
ascli aoc admin user list --query=@ruby:'{"deactivated"=>true,"q"=>"last_login_at:<#{(DateTime.now.to_time.utc-2*365*86400).iso8601}"}'
@@ -7213,7 +7213,7 @@ Option `node_api` (`Hash`) controls some options of API used, with the following
72137213
72147214
| Parameter| Default | Description |
72157215
|----------|---------|-------------|
7216-
| `cache` | `true` | `true` Folder content retrieved from Redis database (faster).<br/>`false` Folder content retrieved from storage. |
7216+
| `cache` | `true` | `true` Folder content is retrieved from the Redis database (faster).<br/>`false` Folder content retrieved from storage. |
72177217
| `standard_ports` | `true` | `true` Use hard coded standard ports (`33001`)<br/>`false` Retrieve server ports from an API call (`download_setup`) which reads the information from `aspera.conf` on the server. |
72187218
| `accept_v4` | `true` | `true` (default) uses API header: `Accept-Version: 4.0`.<br/>`false` uses legacy method (refer to node API). |
72197219
| `per_page` | - | Requested number of items per API call.<br/>Set to `nil` (`@none:`) to deactivate paging.<br/>Default: `1000` when `accept_v4` is `true`. |
@@ -7910,7 +7910,7 @@ The user will use the following options:
79107910
79117911
### Faspex 5 public link authentication
79127912
7913-
If all you have is a public link received by email or other, you can still do authorized actins with it.
7913+
If all you have is a public link received by email or other, you can still do authorized actions with it.
79147914
79157915
For example, for a public link to post a package:
79167916
@@ -9296,7 +9296,9 @@ trevents --once-only=yes --skip-types=office --log-level=info
92969296
92979297
## Operational Utilities
92989298
9299-
This section covers the specialized modules and utilities used to integrate `ascli` into your broader operational infrastructure. While the core plugins handle data movement, these tools provide the "connective tissue" for enterprise environments: Aspera Sync and Hot Folder enable automated, folder-based synchronization; Nagios and SMTP modules provide health monitoring and automated email alerting for transfer status; and `asession` and module manage internal session states and environment configurations. Together, these features transform the CLI from a manual tool into a fully integrated component of an automated, monitored data workflow.
9299+
This section covers the specialized modules and utilities used to integrate `ascli` into your broader operational infrastructure.
9300+
While the core plugins handle data movement, these tools provide the "integration layer" for enterprise environments: Aspera Sync and Hot Folder enable automated, folder-based synchronization; Nagios and SMTP modules provide health monitoring and automated email alerting for transfer status; and `asession` and module manage internal session states and environment configurations.
9301+
Together, these features transform the CLI from a manual tool into a fully integrated component of an automated, monitored data workflow.
93009302
93019303
### IBM Aspera Sync
93029304
@@ -9631,7 +9633,7 @@ Interesting `ascp` features are found in its arguments: (see `ascp` manual):
96319633
- Send only files not modified since the last X seconds:
96329634
- `--exclude-newer-than` (`exclude_newer_than`)
96339635
- `--exclude-older-than` (`exclude_older_than`)
9634-
- Top level folder shall not be created on destination
9636+
- Top level folder should not be created on destination
96359637
- `--src-base` (`src_base`)
96369638
96379639
> [!NOTE]

0 commit comments

Comments
 (0)