Skip to content

Commit bdef277

Browse files
sirosenkurtmckee
andauthored
Update examples to bold terms consistently (#9)
* Update examples to bold terms consistently The following terms are identified here and bolded: - flow - flow definition - flow run - run - state (in a flow) - collection (GCS/Transfer) Notable variations on this: - In some contexts, we write "Guest Collection" -- these are left as-is for now, with no boldfacing. (Should it be `**guest collection**`?) - `Globus-provided Flow` has converted to `Globus-provided **flow**` - We write `**run** ID`, rather than `**run ID**` or similar. * Apply suggestions from code review Co-authored-by: Kurt McKee <contactme@kurtmckee.org> --------- Co-authored-by: Kurt McKee <contactme@kurtmckee.org>
1 parent 2e0799e commit bdef277

File tree

3 files changed

+26
-25
lines changed

3 files changed

+26
-25
lines changed

transfer_examples/move/README.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ The entire directory's contents, including files and subdirectories, will be cop
99
====
1010
This example differs from the
1111
link:https://app.globus.org/flows/f37e5766-7b3c-4c02-92ee-e6aacd8f4cb8/definition[Move (copy and delete) files^]
12-
Globus-provided Flow available in the Globus Web App.
12+
Globus-provided **flow** available in the Globus Web App.
1313
1414
The example is simplified and may exhibit slightly different behaviors.
1515
====
1616

1717
== Highlights
1818

19-
In the example definition, the `IdentifyPathTypes` state uses expression evaluators to prepare several boolean values.
19+
In the example definition, the `IdentifyPathTypes` **state** uses expression evaluators to prepare several boolean values.
2020

21-
These boolean values are used by the `TestPathConstraints` state to conditionally modify the destination path used by the `Transfer` state.
21+
These boolean values are used by the `TestPathConstraints` **state** to conditionally modify the destination path used by the `Transfer` **state**.

transfer_examples/transfer_after_approval/README.adoc

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
Allow users to submit an approval request to transfer a file to a destination Guest Collection.
66

77
The request will come in the form of emails to curators who are authorized to approve the transfer.
8-
If approved, the file will be transferred using the flow's own identity -- not the user's --
9-
ensuring that users do not need permission to read or write to the destination collection.
8+
If approved, the file will be transferred using the **flow**'s own identity -- not the user's --
9+
ensuring that users do not need permission to read or write to the destination **collection**.
1010

11-
Users who run the flow will not be informed who the curators/approvers are,
12-
nor will they be informed by the flow itself where the file is transferred to.
13-
They only need to know that "this flow allows you to submit a file for transfer."
11+
Users who run the **flow** will not be informed who the curators/approvers are,
12+
nor will they be informed by the **flow** itself where the file is transferred to.
13+
They only need to know that "this **flow** allows you to submit a file for transfer."
1414

1515
Example uses include:
1616

@@ -23,46 +23,47 @@ This flow has several technical highlights.
2323

2424
* `__Private_Parameters` and `_private` parameter prefixes are used throughout.
2525
This helps restrict visibility of private information (such as email addresses and SMTP credentials)
26-
when users view the flow definition as well as while the flow runs.
26+
when users view the **flow** definition as well as while their **runs** of the
27+
**flow** are executing.
2728
+
2829
For more information, see link:https://docs.globus.org/api/flows/authoring-flows/secrets/[Protecting Secrets]
2930
in the Authoring Flows documentation.
3031

31-
* By setting the `RunAs` value in the `TransferFile` state,
32-
the transfer operation will be performed using the flow's own identity
32+
* By setting the `RunAs` value in the `TransferFile` **state**,
33+
the transfer operation will be performed using the **flow**'s own identity
3334
to access the destination collection.
34-
This allows the flow to be made public -- and run by any user --
35-
without having to give individual users write permission on the destination collection.
35+
This allows the **flow** to be made public -- and run by any user --
36+
without having to give individual users write permission on the destination **collection**.
3637

3738
== Prerequisites
3839

39-
The flow definition must be modified before using it to create a new flow.
40+
The **flow** definition must be modified before using it to create a new **flow**.
4041
It also has several requirements when running.
4142

4243
=== Modification requirements
4344

44-
* The `SetupEmailLoop` state must be modified.
45+
* The `SetupEmailLoop` **state** must be modified.
4546
The email addresses of approvers must be updated, and unique IDs must be assigned to each reviewer.
4647
Finally, the `loop_end` value must be updated to match the number of approvers.
4748

48-
* The `SendEmail` state must be modified.
49+
* The `SendEmail` **state** must be modified.
4950
Specifically, the SMTP hostname, username, and password in `send_credentials` must be updated,
5051
as well as the email address in `sender`.
5152
+
5253
It is also possible to use an AWS SES credential for sending emails.
5354
See link:https://docs.globus.org/api/flows/hosted-action-providers/ap-notification-notify/[the Notification action provider documentation] for more details.
5455

55-
* The `TransferFile` state must be modified.
56+
* The `TransferFile` **state** must be modified.
5657
The `destination_endpoint` must be set to the destination Guest Collection ID that will receive approved files,
5758
and the `destination_path` should match the target directory you want approved files transferred to.
5859

5960
=== Execution requirements
6061

61-
* After modifying the flow definition and creating the flow in the Globus Flows service,
62+
* After modifying the **flow** definition and creating the **flow** in the Globus Flows service,
6263
a destination collection administrator must give the flow client write permission on the collection.
6364
+
64-
This can be accomplished in the Web App, in the destination collection's Permissions tab,
65-
by clicking the "Add Permissions" button and searching for the flow ID as the username to share with,
65+
This can be accomplished in the Web App, in the destination **collection**'s Permissions tab,
66+
by clicking the "Add Permissions" button and searching for the **flow** ID as the username to share with,
6667
and ensuring that the "Write" checkbox is checked.
6768
+
6869
It's also possible to use the Globus CLI to accomplish this,
@@ -76,5 +77,5 @@ globus endpoint permission create $DESTINATION_COLLECTION_ID:/ --permissions rw
7677
* Users who seek approval to transfer a file must select a file on a Guest Collection
7778
on which they can grant new permissions.
7879

79-
These execution requirements allow the flow -- _acting as the user_ -- to give itself read permission on the user's guest collection,
80-
and then -- _acting as the flow itself_ -- to transfer the user's file to the destination collection.
80+
These execution requirements allow the **flow** -- _acting as the user_ -- to give itself read permission on the user's Guest Collection,
81+
and then -- _acting as the **flow** itself_ -- to transfer the user's file to the destination **collection**.

transfer_examples/two_hop/README.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ Remove from intermediate after completion.
99
====
1010
This example differs from the
1111
link:https://app.globus.org/flows/99791f7d-6c2c-4675-af4b-b927db68bad0/definition[Two Stage Globus Transfer^]
12-
Globus-provided Flow available in the Globus Web App.
12+
Globus-provided **flow** available in the Globus Web App.
1313
1414
The example below is simplified and may exhibit slightly different behaviors.
1515
====
1616

1717
== Highlights
1818

19-
The `ComputeTaskData` state uses the run ID to create a unique temporary directory on the intermediary endpoint.
19+
The `ComputeTaskData` **state** uses the **run** ID to create a unique temporary directory on the intermediate **collection**.
2020

21-
This helps ensure that existing data on the intermediary endpoint are not overwritten by accident.
21+
This helps ensure that existing data on the intermediate **collection** are not overwritten by accident.

0 commit comments

Comments
 (0)