Skip to content

Commit 5aca6c9

Browse files
aj-emerichMalaydewangan09
authored andcommitted
docs(fs): docs fixes
Review part of: #223
1 parent 18c1c11 commit 5aca6c9

File tree

12 files changed

+27
-28
lines changed

12 files changed

+27
-28
lines changed

src/main/java/io/kestra/plugin/fs/ftp/Downloads.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
@Plugin(
2525
examples = {
2626
@Example(
27-
title = "Download a list of files and move it to an archive folders",
27+
title = "Download a list of files and move them to an archive folder",
2828
full = true,
2929
code = """
3030
id: fs_ftp_downloads

src/main/java/io/kestra/plugin/fs/ftp/FtpInterface.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public interface FtpInterface {
2626
Property<Proxy.Type> getProxyType();
2727

2828
@Schema(
29-
title = "Is the path relative to the users home directory"
29+
title = "Is the path relative to the user's home directory"
3030
)
3131
Property<Boolean> getRootDir();
3232

@@ -36,7 +36,7 @@ public interface FtpInterface {
3636
Property<Boolean> getPassiveMode();
3737

3838
@Schema(
39-
title = "Control that the server ip that emit the request is the same than send response."
39+
title = "Ensure the server IP responding matches the one that received the request."
4040
)
4141
Property<Boolean> getRemoteIpVerification();
4242

@@ -65,15 +65,15 @@ class Options {
6565
Property<Duration> socketTimeout = Property.ofValue(Duration.ofSeconds(30));
6666

6767
@Schema(
68-
title = "the control keep alive timeout.",
69-
description = "to ensure the socket be alive after download huge file."
68+
title = "The control keep-alive timeout.",
69+
description = "Ensures the socket stays alive after downloading a large file."
7070
)
7171
@Builder.Default
7272
Property<Duration> controlKeepAliveTimeout = Property.ofValue(Duration.ofSeconds(30));
7373

7474
@Schema(
75-
title = "The control keep alive reply timeout.",
76-
description = "to ensure the socket be alive after download huge file."
75+
title = "The control keep-alive reply timeout.",
76+
description = "Ensures the socket stays alive after downloading a large file."
7777
)
7878
@Builder.Default
7979
Property<Duration> controlKeepAliveReplyTimeout = Property.ofValue(Duration.ofSeconds(30));

src/main/java/io/kestra/plugin/fs/ftps/Downloads.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
@Plugin(
2828
examples = {
2929
@Example(
30-
title = "Download a list of files and move it to an archive folders",
30+
title = "Download a list of files and move them to an archive folder",
3131
full = true,
3232
code = """
3333
id: fs_ftps_downloads

src/main/java/io/kestra/plugin/fs/local/Downloads.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ public class Downloads extends AbstractLocalTask implements RunnableTask<Downloa
106106
private Property<String> regExp;
107107

108108
@Schema(
109-
title = "List file recursively"
109+
title = "List files recursively"
110110
)
111111
@Builder.Default
112112
private Property<Boolean> recursive = Property.ofValue(false);

src/main/java/io/kestra/plugin/fs/local/Trigger.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ public class Trigger extends AbstractTrigger implements PollingTriggerInterface,
8989
private Property<String> from;
9090

9191
@Schema(
92-
title = "The destination directory in case off `MOVE` "
92+
title = "The destination directory in case of `MOVE`"
9393
)
9494
private Property<String> moveDirectory;
9595

@@ -101,7 +101,7 @@ public class Trigger extends AbstractTrigger implements PollingTriggerInterface,
101101
private Property<Boolean> recursive = Property.ofValue(false);
102102

103103
@Schema(
104-
title = "The action to do on downloaded files"
104+
title = "The action to take on downloaded files"
105105
)
106106
@Builder.Default
107107
private Property<Downloads.Action> action = Property.ofValue(Downloads.Action.NONE);
@@ -220,4 +220,3 @@ public static class Output implements io.kestra.core.models.tasks.Output {
220220
}
221221

222222
}
223-
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
@PluginSubGroup(
2-
description = "This sub-group of plugins contains tasks for accessing files using local file system.",
2+
description = "This sub-group of plugins contains tasks for accessing files using the local file system.",
33
categories = PluginSubGroup.PluginCategory.STORAGE
44
)
55
package io.kestra.plugin.fs.local;
66

7-
import io.kestra.core.models.annotations.PluginSubGroup;
7+
import io.kestra.core.models.annotations.PluginSubGroup;

src/main/java/io/kestra/plugin/fs/sftp/Downloads.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
@Plugin(
2424
examples = {
2525
@Example(
26-
title = "Download a list of files and move it to an archive folders",
26+
title = "Download a list of files and move them to an archive folder",
2727
full = true,
2828
code = """
2929
id: fs_sftp_downloads

src/main/java/io/kestra/plugin/fs/sftp/SftpInterface.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55

66
public interface SftpInterface {
77
@Schema(
8-
title = "Private keyfile in the PEM file format to connect to a remote server using SSH",
9-
description = "To generate a PEM format key from OpenSSH, use the following command: `ssh-keygen -m PEM`"
8+
title = "Private key file in the PEM format to connect to a remote server using SSH",
9+
description = "To generate a PEM-format key from OpenSSH, use the following command: `ssh-keygen -m PEM`"
1010
)
1111
Property<String> getKeyfile();
1212

1313
@Schema(
14-
title = "Passphrase of the ssh key"
14+
title = "Passphrase for the SSH key"
1515
)
1616
Property<String> getPassphrase();
1717

@@ -55,12 +55,12 @@ public interface SftpInterface {
5555
Property<String> getProxyType();
5656

5757
@Schema(
58-
title = "Is the path relative to the users home directory"
58+
title = "Is the path relative to the user's home directory"
5959
)
6060
Property<Boolean> getRootDir();
6161

6262
@Schema(
63-
title = "Configures Key exchange algorithm explicitly e. g diffie-hellman-group14-sha1, diffie-hellman-group-exchange-sha256, diffie-hellman-group-exchange-sha1, diffie-hellman-group1-sha1."
63+
title = "Configures the key exchange algorithm explicitly (e.g., diffie-hellman-group14-sha1, diffie-hellman-group-exchange-sha256, diffie-hellman-group-exchange-sha1, diffie-hellman-group1-sha1)."
6464
)
6565
Property<String> getKeyExchangeAlgorithm();
6666
}

src/main/java/io/kestra/plugin/fs/smb/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
@PluginSubGroup(
22
title = "SMB (Server Message Block)",
3-
description = "This sub-group of plugins contains tasks for accessing files using the SMB protocol (Samba for eg.).",
3+
description = "This sub-group of plugins contains tasks for accessing files using the SMB protocol (Samba, for example).",
44
categories = PluginSubGroup.PluginCategory.STORAGE
55
)
66
package io.kestra.plugin.fs.smb;

src/main/java/io/kestra/plugin/fs/vfs/Downloads.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public abstract class Downloads extends AbstractVfsTask implements RunnableTask<
3232
private Property<String> from;
3333

3434
@Schema(
35-
title = "The action to do on downloaded files"
35+
title = "The action to take on downloaded files"
3636
)
3737
private Property<Downloads.Action> action;
3838

@@ -47,7 +47,7 @@ public abstract class Downloads extends AbstractVfsTask implements RunnableTask<
4747
private Property<String> regExp;
4848

4949
@Schema(
50-
title = "List file recursively"
50+
title = "List files recursively"
5151
)
5252
@Builder.Default
5353
private Property<Boolean> recursive = Property.ofValue(false);

0 commit comments

Comments
 (0)