Skip to content

Commit ab97f99

Browse files
Feat/no trailing spaces in *.md files (#3432)
2 parents c745de8 + fb3b20e commit ab97f99

18 files changed

+89
-74
lines changed
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: Trailing spaces
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- master
7+
- support/**
8+
9+
jobs:
10+
example:
11+
runs-on: ubuntu-latest
12+
name: Search spaces in *.md files
13+
steps:
14+
- uses: actions/checkout@v4
15+
- uses: ocular-d/[email protected]

CREDITS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ In alphabetical order:
88
- Alexey Vanin
99
- Anastasia Prasolova
1010
- Anatoly Bogatyrev
11-
- Evgeny Kulikov
11+
- Evgeny Kulikov
1212
- Evgeny Stratonikov
1313
- Leonard Liubich
1414
- Sergei Liubich

config/mainnet/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# N3 Mainnet Storage node configuration
22

33
Here is a template for simple storage node configuration in N3 Mainnet.
4-
Make sure to specify correct values instead of `<...>` placeholders.
4+
Make sure to specify correct values instead of `<...>` placeholders.
55
Do not change `contracts` section. Run the latest neofs-node release with
66
the fixed config `neofs-node -c config.yml`
77

88
To use NeoFS in the Mainnet, you need to deposit assets to NeoFS contract.
9-
The contract sript hash is `2cafa46838e8b564468ebd868dcafdd99dce6221`
9+
The contract sript hash is `2cafa46838e8b564468ebd868dcafdd99dce6221`
1010
(N3 address `NNxVrKjLsRkWsmGgmuNXLcMswtxTGaNQLk`)
1111

1212
## Tips

config/testnet/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ docker image and run it with docker-compose.
66

77
## Build image
88

9-
Prepared **neofs-storage-testnet** image is available at Docker Hub.
10-
However, if you need to rebuild it for some reason, run
9+
Prepared **neofs-storage-testnet** image is available at Docker Hub.
10+
However, if you need to rebuild it for some reason, run
1111
`make image-storage-testnet` command.
1212

1313
```
@@ -19,13 +19,13 @@ Successfully tagged nspccdev/neofs-storage-testnet:0.25.1
1919

2020
## Deploy node
2121

22-
To run a storage node in N3 Testnet environment, you should deposit GAS assets,
22+
To run a storage node in N3 Testnet environment, you should deposit GAS assets,
2323
update docker-compose file and start the node.
2424

2525
### Deposit
2626

27-
The Storage Node owner should deposit GAS to NeoFS smart contract. It generates a
28-
bit of sidechain GAS in the node's wallet. Sidechain GAS is used to send bootstrap tx.
27+
The Storage Node owner should deposit GAS to NeoFS smart contract. It generates a
28+
bit of sidechain GAS in the node's wallet. Sidechain GAS is used to send bootstrap tx.
2929

3030
First, obtain GAS in N3 Testnet chain. You can do that with
3131
[faucet](https://neowish.ngd.network) service.
@@ -34,7 +34,7 @@ Then, make a deposit by transferring GAS to NeoFS contract in N3 Testnet.
3434
You can provide scripthash in the `data` argument of transfer tx to make a
3535
deposit to a specified account. Otherwise, deposit is made to the tx sender.
3636

37-
NeoFS contract scripthash in N3 Testnet is `b65d8243ac63983206d17e5221af0653a7266fa1`,
37+
NeoFS contract scripthash in N3 Testnet is `b65d8243ac63983206d17e5221af0653a7266fa1`,
3838
so the address is `NadZ8YfvkddivcFFkztZgfwxZyKf1acpRF`.
3939

4040
See a deposit example with `neo-go`.
@@ -57,7 +57,7 @@ NEOFS_GRPC_0_ENDPOINT=65.52.183.157:36512
5757
NEOFS_NODE_ADDRESSES=65.52.183.157:36512
5858
```
5959

60-
Set up your [UN/LOCODE](https://unece.org/trade/cefact/unlocode-code-list-country-and-territory)
60+
Set up your [UN/LOCODE](https://unece.org/trade/cefact/unlocode-code-list-country-and-territory)
6161
attribute.
6262

6363
```
@@ -66,7 +66,7 @@ NEOFS_NODE_ADDRESSES=65.52.183.157:36512
6666
NEOFS_NODE_ATTRIBUTE_2=UN-LOCODE:RU LED
6767
```
6868

69-
You can validate UN/LOCODE attribute in
69+
You can validate UN/LOCODE attribute in
7070
[NeoFS LOCODE database](https://github.com/nspcc-dev/neofs-locode-db/releases/tag/v0.1.0)
7171
with neofs-cli.
7272

@@ -79,7 +79,7 @@ Subdivision: [SPE] Sankt-Peterburg
7979
Coordinates: 59.53, 30.15
8080
```
8181

82-
It is recommended to pass the node's key as a file. To do so, convert your wallet
82+
It is recommended to pass the node's key as a file. To do so, convert your wallet
8383
WIF to 32-byte hex (via `neofs-cli` for example) and save it to a file.
8484

8585
```
@@ -104,8 +104,8 @@ Then, specify the path to this file in `docker-compose.yml`
104104
```
105105
106106
107-
NeoFS objects will be stored on your machine. By default, docker-compose
108-
is configured to store objects in named docker volume `neofs_storage`. You can
107+
NeoFS objects will be stored on your machine. By default, docker-compose
108+
is configured to store objects in named docker volume `neofs_storage`. You can
109109
specify a directory on the filesystem to store objects there.
110110

111111
```yaml
@@ -120,7 +120,7 @@ Run the node with `docker-compose up` command and stop it with `docker-compose d
120120

121121
### Debug
122122

123-
To print node logs, use `docker logs neofs-testnet`. To print debug messages in
123+
To print node logs, use `docker logs neofs-testnet`. To print debug messages in
124124
log, set up log level to debug with this env:
125125

126126
```yaml

docs/cli-adm.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,21 @@
33
## Overview
44

55
Admin tool provides an easier way to deploy and maintain private installation
6-
of NeoFS. Private installation provides a set of N3 consensus nodes, NeoFS
7-
Alphabet, and Storage nodes. Admin tool generates consensus keys, initializes
6+
of NeoFS. Private installation provides a set of N3 consensus nodes, NeoFS
7+
Alphabet, and Storage nodes. Admin tool generates consensus keys, initializes
88
the sidechain, and provides functions to update the network and register new
99
Storage nodes.
1010

1111
## Build
1212

13-
To build binary locally, use `make bin/neofs-adm` command.
13+
To build binary locally, use `make bin/neofs-adm` command.
1414

15-
For clean build inside a docker container, use `make docker/bin/neofs-adm`.
15+
For clean build inside a docker container, use `make docker/bin/neofs-adm`.
1616

1717
Build docker image with `make image-adm`.
1818

19-
At NeoFS private install deployment, neofs-adm requires compiled NeoFS
20-
contracts. Find them in the latest release of
19+
At NeoFS private install deployment, neofs-adm requires compiled NeoFS
20+
contracts. Find them in the latest release of
2121
[neofs-contract repository](https://github.com/nspcc-dev/neofs-contract/releases).
2222

2323

@@ -27,7 +27,7 @@ contracts. Find them in the latest release of
2727

2828
Config section provides `init` command that creates a configuration file for
2929
private installation deployment and updates. Config file is optional, all
30-
parameters can be passed by arguments or read from standard input (wallet
30+
parameters can be passed by arguments or read from standard input (wallet
3131
passwords).
3232

3333
Config example:
@@ -58,14 +58,14 @@ credentials: # passwords for consensus node / alphabet wallets
5858
5959
#### Network deployment
6060
61-
- `generate-alphabet` generates a set of wallets for consensus and
62-
Alphabet nodes.
61+
- `generate-alphabet` generates a set of wallets for consensus and
62+
Alphabet nodes.
6363

6464
- `init` initializes the sidechain by deploying smart contracts and
6565
setting provided NeoFS network configuration.
6666

67-
- `generate-storage-wallet` generates a wallet for the Storage node that
68-
is ready for deployment. It also transfers a bit of sidechain GAS, so this
67+
- `generate-storage-wallet` generates a wallet for the Storage node that
68+
is ready for deployment. It also transfers a bit of sidechain GAS, so this
6969
wallet can be used for NeoFS bootstrap.
7070

7171
#### Network maintenance
@@ -79,7 +79,7 @@ credentials: # passwords for consensus node / alphabet wallets
7979

8080
- `renew-domain` updates expiration date of the given domain for one year.
8181

82-
- `refill-gas` transfers sidechain GAS to the specified wallet.
82+
- `refill-gas` transfers sidechain GAS to the specified wallet.
8383

8484
- `update-contracts` updates contracts to a new version.
8585

@@ -91,7 +91,7 @@ info. These commands **do not migrate actual objects**.
9191
- `dump-containers` saves all containers and metadata registered in the container
9292
contract to a file.
9393

94-
- `restore-containers` restores previously saved containers by their repeated registration in
94+
- `restore-containers` restores previously saved containers by their repeated registration in
9595
the container contract.
9696

9797
- `list-containers` output all containers ids.

docs/cli-commands/neofs-cli_acl_extended_create.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ Action is 'allow' or 'deny'.
1313
Operation is an object service verb: 'get', 'head', 'put', 'search', 'delete', 'getrange', or 'getrangehash'.
1414

1515
Filter consists of <typ>:<key><match><value>
16-
Typ is 'obj' for object applied filter or 'req' for request applied filter.
17-
Key is a valid unicode string corresponding to object or request header key.
16+
Typ is 'obj' for object applied filter or 'req' for request applied filter.
17+
Key is a valid unicode string corresponding to object or request header key.
1818
Well-known system object headers start with '$Object:' prefix.
1919
User defined headers start without prefix.
2020
Read more about filter keys at github.com/nspcc-dev/neofs-api/blob/master/proto-docs/acl.md#message-eaclrecordfilter
@@ -24,10 +24,10 @@ Filter consists of <typ>:<key><match><value>
2424
'>' | '>=' | '<' | '<=' for integer comparison.
2525
Value is a valid unicode string corresponding to object or request header value. Numeric filters must have base-10 integer values.
2626

27-
Target is
28-
'user' for container owner,
27+
Target is
28+
'user' for container owner,
2929
'system' for Storage nodes in container and Inner Ring nodes,
30-
'others' for all other request senders,
30+
'others' for all other request senders,
3131
'address:<adr1>,<adr2>,...' for exact request sender, where <adr> is a base58 25-byte address. Example: NSiVJYZej4XsxG5CUpdwn7VRQk8iiiDMPM.
3232

3333
When both '--rule' and '--file' arguments are used, '--rule' records will be placed higher in resulting extended ACL table.

docs/cli-commands/neofs-cli_completion.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ Zsh:
1919
If shell completion is not already enabled in your environment you will need
2020
to enable it. You can execute the following once:
2121
$ echo "autoload -U compinit; compinit" >> ~/.zshrc
22-
22+
2323
To load completions for each session, execute once:
2424
$ neofs-cli completion zsh > "${fpath[1]}/_neofs-cli"
25-
25+
2626
You will need to start a new shell for this setup to take effect.
2727

2828
Fish:
2929
$ neofs-cli completion fish | source
30-
30+
3131
To load completions for each session, execute once:
3232
$ neofs-cli completion fish > ~/.config/fish/completions/neofs-cli.fish
3333

docs/cli-commands/neofs-cli_container_create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Create new container
44

55
### Synopsis
66

7-
Create new container and register it in the NeoFS.
7+
Create new container and register it in the NeoFS.
88
It will be stored in FS chain when inner ring will accepts it.
99

1010
```

docs/cli-commands/neofs-cli_container_delete.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Delete existing container
44

55
### Synopsis
66

7-
Delete existing container.
7+
Delete existing container.
88
Only owner of the container has a permission to remove container.
99

1010
```

docs/cli-commands/neofs-cli_session_create.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Create session token
66

77
Create session token.
88

9-
Default lifetime of session token is 10 epochs
10-
if none of --expire-at or --lifetime flags is specified.
9+
Default lifetime of session token is 10 epochs
10+
if none of --expire-at or --lifetime flags is specified.
1111

1212

1313
```

0 commit comments

Comments
 (0)