style: docs/config.md
Co-authored-by: Jessica Schilling <jessica@protocol.ai> (cherry picked from commit aaa64baaed2a032036242768c4088647cfb59d20)
Marcin Rataj committed
Feb 15, 2021 at 21:28 UTC
94dd4be8f8fd074ca2a48734501b4b2332b629a9
1 file changed
+9
-9
docs/config.md
+9
-9
@@ -872,15 +872,15 @@ Type: `string`
872
873
#### `Pinning.RemoteServices: Policies`
874
875
-Contains additional opt-in policies for the remote pinning service
875
+Contains additional opt-in policies for the remote pinning service.
876
877
##### `Pinning.RemoteServices: Policies.MFS`
878
879
-When this policy is enabled it will be following changes to MFS
880
-and updating the pin for MFS root on the configured remote service.
879
+When this policy is enabled, it follows changes to MFS
880
+and updates the pin for MFS root on the configured remote service.
881
882
-Pin request to the remote service is sent only when MFS root changed
883
-and time passed since the previous pin is bigger than `RepinInterval`.
882
+A pin request to the remote service is sent only when MFS root has changed
883
+and time has passed, since the previous pin is bigger than `RepinInterval`.
884
885
###### `Pinning.RemoteServices: Policies.MFS.Enabled`
886
@@ -892,8 +892,8 @@ Type: `bool`
892
893
###### `Pinning.RemoteServices: Policies.MFS.PinName`
894
895
-Optional name to use for remote pin that represents MFS root CID.
896
-When left empty, default name will be generated.
895
+Optional name to use for a remote pin that represents the MFS root CID.
896
+When left empty, a default name will be generated.
897
898
Default: `"policy/{PeerID}/mfs"`, e.g. `"policy/12.../mfs"`
899
@@ -901,8 +901,8 @@ Type: `string`
901
902
###### `Pinning.RemoteServices: Policies.MFS.RepinInterval`
903
904
-Defines how often (at most) the pin request should be sent to remote service.
905
-When left empty, default interval will be used. Values lower than `1m` will be ignored.
904
+Defines how often (at most) the pin request should be sent to the remote service.
905
+If left empty, the default interval will be used. Values lower than `1m` will be ignored.
906
907
Default: `"5m"`
908