Update chapter 4 and 6 #29

CunliangGeng · 2024-06-11T12:07:28Z

To address the issues #26 and #27 .

this section will be moved to ch6

This section has been moved to ch3

the content is moved from ch4 with some adaptions.

github-actions · 2024-06-11T12:07:47Z

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

🎯 correct output
🖼️ correct figures
❓ new warnings
‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/vantage6/vantage6-workshop/compare/md-outputs..md-outputs-PR-29

The following changes were observed in the rendered markdown documents:

 chapter4.md | 114 +++++++++---------------------------------------------------
 chapter6.md | 106 +++++++++++++++++++++++--------------------------------
 md5sum.txt  |   4 +--
 3 files changed, 63 insertions(+), 161 deletions(-)

What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2024-06-20 07:02:55 +0000

wbaccinelli

Looks good!

episodes/chapter4.md

episodes/chapter6.md

Co-authored-by: Walter Baccinelli <100706999+wbaccinelli@users.noreply.github.com>

bartvanb

Nice changes! I have just a few small things.

bartvanb · 2024-06-12T15:07:19Z

episodes/chapter4.md

@@ -194,6 +132,9 @@ You will see a message:
 >
 > Please distribute each of these keys privately to each of the organizations. Note that they may reset their API key so that no-one but them knows it.

+You will need this API key to register the nodes of the organizations in the collaboration. For more details, see [the chapter of setting up a vantage6 node](./chapter6.md).


I would not say register - in my view that is what you have just done by creating the collaboration and the node. I would rather say something like You will need the API keys when you run the nodes to authenticate with the server

And I would say instead of the second sentence We will discuss this tomorrow in [link to chapter 6]

Usually participants get the lesson material after the workshop. So it's better not to mention tomorrow ;-)

In that case, maybe 'We will discuss this later in chapter 6' ;-)

bartvanb · 2024-06-12T15:08:55Z

episodes/chapter4.md


-Go the administration page in the vantage6 UI and try to create a new organization, a new user, and a new collaboration. Also, try to reset the API key for a node.
+Go to the administration page in the vantage6 UI, and try to do the following:


nitpicking: maybe delete the words try to
That way we show that we have faith in our participants :-)

bartvanb · 2024-06-12T15:11:29Z

episodes/chapter4.md

 - Vantage6 uses a permission system to control who can do what in the system.
 - Vantage6 has default roles like  `Root`, `Collaboration Admin`, `Organization Admin`, `Researcher`, and `Viewer`.
- Vantage6 UI can be used to manage the entities of vantage6, like creating a new organization, a new user, a new collaboration, and resetting an api key for a node.
+- Vantage6 UI can be used to manage the entities of vantage6, like creating a new organization, a new user, or a new collaboration.


We should mention somewhere that you can of course also delete resources (though we're not going to let them do it themselves as they will not have the permission because they could mess up the entire workshop - we could e.g. show it on the screen)

The challenge 1 has mentioned that, and they also can see it in the figures 1 & 2.

bartvanb · 2024-06-12T15:13:08Z

episodes/chapter6.md

-
-:::
-
-::::::::::::::::::::::::::::::::::::::::::::::::


Just to note: this has been added back on the branch where we add setup right?

Yes, but with quite some adaptions. If you like, please also review #31.

bartvanb · 2024-06-12T15:16:54Z

episodes/chapter6.md


 1. Create a new node configuration using the `v6 node new` command.
 2. Find the path to the configuration file using the `v6 node files` command. Open the configuration file with a text editor and check the configuration options. Are they correct?
+3. Add some missing options to your configuration file. You can find all options in the [vantage6 documentation](https://docs.vantage6.ai/en/main/node/configure.html#all-configuration-options).


Maybe it would be good to specify which options these should be, as adding some options may lead to weird behaviour (e.g. if they add allowed_algorithms some algorithms later in the course may not be executed). And ideally it would be something they get reminded of later.

Good catch. I'm afraid the participants will be blocked by what values to add for the missing options. So I would ask them to add a new database in a different format, change the encryption option, and find the missing options.

That sounds good! Be sure to say that they should also change the encryption option back in that case

bartvanb · 2024-06-12T15:22:30Z

episodes/chapter6.md


-1. How do you update the API key of a node? Try to update the API key of the node you just created, without using the `v6 node set-api-key` command.
-2. How do you make sure the new API key is effective?
+1. How to reset the API key of a node via the vantage6 UI? Try to reset the API key of a node you just created.


I would just say "Reset the API key of the node that you just created in the vantage6 UI"

bartvanb · 2024-06-12T15:23:02Z

episodes/chapter6.md

-1. How do you update the API key of a node? Try to update the API key of the node you just created, without using the `v6 node set-api-key` command.
-2. How do you make sure the new API key is effective?
+1. How to reset the API key of a node via the vantage6 UI? Try to reset the API key of a node you just created.
+2. How do you update the API key of a node? Try to update the API key of the node you just created, without using the `v6 node set-api-key` command.


And then maybe "Update the API key of ..." (leave out first part)

CunliangGeng · 2024-06-13T08:35:13Z

@bartvanb @wbaccinelli Applied your suggestions, please have a look again.

wbaccinelli · 2024-06-13T08:39:09Z

@bartvanb @wbaccinelli Applied your suggestions, please have a look again.

@CunliangGeng good for me :)

bartvanb

I haven't looked again but it was already good last time I saw it. I prefer to have another detailed look at everything together when we have a draft of everything so let's merge this now!

Auto-generated via {sandpaper} Source : 3b48c4f Branch : main Author : Bart van Beusekom <b.vanbeusekom@iknl.nl> Time : 2024-06-25 08:17:34 +0000 Message : Merge pull request #29 from vantage6/update_ch4_ch6 Update chapter 4 and 6

Auto-generated via {sandpaper} Source : 0f07395 Branch : md-outputs Author : GitHub Actions <actions@github.com> Time : 2024-06-25 08:18:45 +0000 Message : markdown source builds Auto-generated via {sandpaper} Source : 3b48c4f Branch : main Author : Bart van Beusekom <b.vanbeusekom@iknl.nl> Time : 2024-06-25 08:17:34 +0000 Message : Merge pull request #29 from vantage6/update_ch4_ch6 Update chapter 4 and 6

CunliangGeng added 7 commits June 11, 2024 13:18

remove challenge 1 from ch6

bd482ac

add one more question to challenge 2 of ch6

1442f03

re-number challenges of ch6

5d63b52

remove section reset API key from ch4

eb0ff89

this section will be moved to ch6

remove section 1 of ch4

6ab9dd1

This section has been moved to ch3

Update chapter4.md

90e231b

add reset API key to ch6

3adc842

the content is moved from ch4 with some adaptions.

CunliangGeng requested a review from wbaccinelli June 11, 2024 12:07

CunliangGeng requested a review from bartvanb June 11, 2024 12:08

CunliangGeng self-assigned this Jun 11, 2024

github-actions bot pushed a commit that referenced this pull request Jun 11, 2024

differences for PR #29

1cea14e

wbaccinelli approved these changes Jun 12, 2024

View reviewed changes

episodes/chapter4.md Show resolved Hide resolved

episodes/chapter6.md Outdated Show resolved Hide resolved

Apply suggestions from code review

d27eccd

Co-authored-by: Walter Baccinelli <100706999+wbaccinelli@users.noreply.github.com>

github-actions bot pushed a commit that referenced this pull request Jun 12, 2024

differences for PR #29

f30e90e

bartvanb reviewed Jun 12, 2024

View reviewed changes

apply reviewer's suggestions

6bb090f

github-actions bot pushed a commit that referenced this pull request Jun 13, 2024

differences for PR #29

400bdb2

update ubuntu version

6ddd9db

github-actions bot pushed a commit that referenced this pull request Jun 20, 2024

differences for PR #29

48276c9

bartvanb approved these changes Jun 21, 2024

View reviewed changes

bartvanb merged commit 3b48c4f into main Jun 25, 2024
3 checks passed

bartvanb deleted the update_ch4_ch6 branch June 25, 2024 08:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update chapter 4 and 6 #29

Update chapter 4 and 6 #29

CunliangGeng commented Jun 11, 2024

github-actions bot commented Jun 11, 2024 •

edited

Loading

wbaccinelli left a comment

bartvanb left a comment

bartvanb Jun 12, 2024

bartvanb Jun 12, 2024

CunliangGeng Jun 13, 2024

bartvanb Jun 13, 2024

bartvanb Jun 12, 2024

bartvanb Jun 12, 2024

CunliangGeng Jun 13, 2024

bartvanb Jun 12, 2024

CunliangGeng Jun 13, 2024

bartvanb Jun 12, 2024

CunliangGeng Jun 13, 2024

bartvanb Jun 13, 2024

bartvanb Jun 12, 2024

bartvanb Jun 12, 2024

CunliangGeng commented Jun 13, 2024 •

edited

Loading

wbaccinelli commented Jun 13, 2024

bartvanb left a comment •

edited

Loading


		Go the administration page in the vantage6 UI and try to create a new organization, a new user, and a new collaboration. Also, try to reset the API key for a node.
		Go to the administration page in the vantage6 UI, and try to do the following:


		:::

		::::::::::::::::::::::::::::::::::::::::::::::::

Update chapter 4 and 6 #29

Update chapter 4 and 6 #29

Conversation

CunliangGeng commented Jun 11, 2024

github-actions bot commented Jun 11, 2024 • edited Loading

Thank you!

Rendered Changes

wbaccinelli left a comment

Choose a reason for hiding this comment

bartvanb left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CunliangGeng commented Jun 13, 2024 • edited Loading

wbaccinelli commented Jun 13, 2024

bartvanb left a comment • edited Loading

Choose a reason for hiding this comment

github-actions bot commented Jun 11, 2024 •

edited

Loading

CunliangGeng commented Jun 13, 2024 •

edited

Loading

bartvanb left a comment •

edited

Loading