Add top level goal explanation and clarify some point #7
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cmin764
suggested changes
Jun 14, 2023
There was a problem hiding this comment.
I like the fact that we put into highlight when to generate the token (that requires human intervention) and when that isn't needed anymore!
Although it was already clearly explained twice here under Robot run:
But is good to have it stated one more time from the beginning!
Comment on lines
+9
to
+13
| <table><td>:memo: **Note**: | ||
| This more complex authorization flow must be done once via an attended run, but once | ||
| completed, your automation using the final vault objects will be able to send and | ||
| receive emails unattendedly. We recommend you use this portal bot to complete the | ||
| initial setup within your workspace.</td></table> |
There was a problem hiding this comment.
Suggested change
| <table><td>:memo: **Note**: | |
| This more complex authorization flow must be done once via an attended run, but once | |
| completed, your automation using the final vault objects will be able to send and | |
| receive emails unattendedly. We recommend you use this portal bot to complete the | |
| initial setup within your workspace.</td></table> | |
| <table><td>:memo: Note: | |
| This more complex authorization flow must be done once via an attended run, but once | |
| completed, your automation using the final token from the Vault will be able to send and | |
| receive e-mails unattendedly. We recommend you use this Portal robot to complete the | |
| initial setup within your workspace.</td></table> |
- The Note strong emphasis
- Small Vault reformulation
Since it was rendered like (no full Markdown support I believe):
| @@ -108,8 +115,10 @@ token itself needs an entry in the Vault so the robot can update its value in th | |||
|
|
|||
| ### Online Control Room Vault | |||
|
|
|||
| Create a secret called `email_oauth_google/microsoft` in Control Room's Vault with the | |||
| following entries (and make sure to connect **VSCode** to the online Vault afterwards): | |||
| Create a secret called `email_oauth_[service]` (where you replace `[service]` with either | |||
There was a problem hiding this comment.
Good refactoring, thank you!
| @@ -131,14 +140,15 @@ If you can't use the online cloud Vault: | |||
| ## Robot run | |||
|
|
|||
| Run with **VSCode** or **rcc** the following tasks in order: | |||
| 1. `Init Google/Microsoft OAuth`: Opens a browser window for you to authenticate and | |||
| 1. `Init Google` / `Microsoft OAuth`: Opens a browser window for you to authenticate and | |||
There was a problem hiding this comment.
This might create some confusion, as there's no individual Init Google or Microsoft OAuth task.
What about:
Suggested change
| 1. `Init Google` / `Microsoft OAuth`: Opens a browser window for you to authenticate and | |
| 1. `Init Google OAuth` / `Init Microsoft OAuth`: Opens a browser window for you to authenticate and |
?
And make sure you apply the same idiom in other places like Tasks as well:
| @@ -155,7 +165,7 @@ Run with **VSCode** or **rcc** the following tasks in order: | |||
| - This step is required to be run once, requires human intervention (attended) and | |||
| once you get your token generated, it will stay valid (by refreshing itself) | |||
| indefinitely. | |||
| 2. `Send Google/Microsoft Email`: Sends a test e-mail to yourself given the credentials | |||
| 2. `Send Google` / `Microsoft Email`: Sends a test e-mail to yourself given the credentials | |||
There was a problem hiding this comment.
☝🏼 Same as on the point above, with the Init ... keywords.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.