commit 3da969ecd2953b85d26528dc207f8c01019a4a54 Author: Emils Bernhards Date: Sat Jun 12 12:47:30 2021 +0200 Shared workspace manual added. diff --git a/shared-workspace-manual/.gitignore b/shared-workspace-manual/.gitignore new file mode 100644 index 0000000..87620ac --- /dev/null +++ b/shared-workspace-manual/.gitignore @@ -0,0 +1 @@ +.ipynb_checkpoints/ diff --git a/shared-workspace-manual/README.md b/shared-workspace-manual/README.md new file mode 100644 index 0000000..c54a2f4 --- /dev/null +++ b/shared-workspace-manual/README.md @@ -0,0 +1,3 @@ +# platform-manuals + +This repository stores the manuals written for using the system and any additional web apps. \ No newline at end of file diff --git a/shared-workspace-manual/guide.pdf b/shared-workspace-manual/guide.pdf new file mode 100644 index 0000000..4e18a67 Binary files /dev/null and b/shared-workspace-manual/guide.pdf differ diff --git a/shared-workspace-manual/shared-workspace-manual-ss/canvas-api-key.png b/shared-workspace-manual/shared-workspace-manual-ss/canvas-api-key.png new file mode 100644 index 0000000..43667cc Binary files /dev/null and b/shared-workspace-manual/shared-workspace-manual-ss/canvas-api-key.png differ diff --git a/shared-workspace-manual/shared-workspace-manual-ss/copy-generated-token.png b/shared-workspace-manual/shared-workspace-manual-ss/copy-generated-token.png new file mode 100644 index 0000000..559503f Binary files /dev/null and b/shared-workspace-manual/shared-workspace-manual-ss/copy-generated-token.png differ diff --git a/shared-workspace-manual/shared-workspace-manual-ss/delete-token.png b/shared-workspace-manual/shared-workspace-manual-ss/delete-token.png new file mode 100644 index 0000000..9918d05 Binary files /dev/null and b/shared-workspace-manual/shared-workspace-manual-ss/delete-token.png differ diff --git a/shared-workspace-manual/shared-workspace-manual-ss/enter-workspace-name.png b/shared-workspace-manual/shared-workspace-manual-ss/enter-workspace-name.png new file mode 100644 index 0000000..2d3e6c1 Binary files /dev/null and b/shared-workspace-manual/shared-workspace-manual-ss/enter-workspace-name.png differ diff --git a/shared-workspace-manual/shared-workspace-manual-ss/itc-logo.png b/shared-workspace-manual/shared-workspace-manual-ss/itc-logo.png new file mode 100644 index 0000000..f261b4b Binary files /dev/null and b/shared-workspace-manual/shared-workspace-manual-ss/itc-logo.png differ diff --git a/shared-workspace-manual/shared-workspace-manual-ss/original/canvas-api-key.png b/shared-workspace-manual/shared-workspace-manual-ss/original/canvas-api-key.png new file mode 100644 index 0000000..9c5309d Binary files /dev/null and b/shared-workspace-manual/shared-workspace-manual-ss/original/canvas-api-key.png differ diff --git a/shared-workspace-manual/shared-workspace-manual-ss/original/copy-generated-token.png b/shared-workspace-manual/shared-workspace-manual-ss/original/copy-generated-token.png new file mode 100644 index 0000000..e3e763c Binary files /dev/null and b/shared-workspace-manual/shared-workspace-manual-ss/original/copy-generated-token.png differ diff --git a/shared-workspace-manual/shared-workspace-manual-ss/original/delete-token.png b/shared-workspace-manual/shared-workspace-manual-ss/original/delete-token.png new file mode 100644 index 0000000..f86a4cc Binary files /dev/null and b/shared-workspace-manual/shared-workspace-manual-ss/original/delete-token.png differ diff --git a/shared-workspace-manual/shared-workspace-manual-ss/original/enter-workspace-name.png b/shared-workspace-manual/shared-workspace-manual-ss/original/enter-workspace-name.png new file mode 100644 index 0000000..b229bac Binary files /dev/null and b/shared-workspace-manual/shared-workspace-manual-ss/original/enter-workspace-name.png differ diff --git a/shared-workspace-manual/shared-workspace-manual-ss/original/paste-token-webapp.png b/shared-workspace-manual/shared-workspace-manual-ss/original/paste-token-webapp.png new file mode 100644 index 0000000..4a0d8bf Binary files /dev/null and b/shared-workspace-manual/shared-workspace-manual-ss/original/paste-token-webapp.png differ diff --git a/shared-workspace-manual/shared-workspace-manual-ss/original/save-workspace.png b/shared-workspace-manual/shared-workspace-manual-ss/original/save-workspace.png new file mode 100644 index 0000000..5d7a13f Binary files /dev/null and b/shared-workspace-manual/shared-workspace-manual-ss/original/save-workspace.png differ diff --git a/shared-workspace-manual/shared-workspace-manual-ss/original/select-course.png b/shared-workspace-manual/shared-workspace-manual-ss/original/select-course.png new file mode 100644 index 0000000..e8c4e9d Binary files /dev/null and b/shared-workspace-manual/shared-workspace-manual-ss/original/select-course.png differ diff --git a/shared-workspace-manual/shared-workspace-manual-ss/original/set-access-rights.png b/shared-workspace-manual/shared-workspace-manual-ss/original/set-access-rights.png new file mode 100644 index 0000000..9042e32 Binary files /dev/null and b/shared-workspace-manual/shared-workspace-manual-ss/original/set-access-rights.png differ diff --git a/shared-workspace-manual/shared-workspace-manual-ss/paste-token-webapp.png b/shared-workspace-manual/shared-workspace-manual-ss/paste-token-webapp.png new file mode 100644 index 0000000..306665c Binary files /dev/null and b/shared-workspace-manual/shared-workspace-manual-ss/paste-token-webapp.png differ diff --git a/shared-workspace-manual/shared-workspace-manual-ss/save-workspace.png b/shared-workspace-manual/shared-workspace-manual-ss/save-workspace.png new file mode 100644 index 0000000..23edaf1 Binary files /dev/null and b/shared-workspace-manual/shared-workspace-manual-ss/save-workspace.png differ diff --git a/shared-workspace-manual/shared-workspace-manual-ss/select-course.png b/shared-workspace-manual/shared-workspace-manual-ss/select-course.png new file mode 100644 index 0000000..f9252b6 Binary files /dev/null and b/shared-workspace-manual/shared-workspace-manual-ss/select-course.png differ diff --git a/shared-workspace-manual/shared-workspace-manual-ss/set-access-rights.png b/shared-workspace-manual/shared-workspace-manual-ss/set-access-rights.png new file mode 100644 index 0000000..82d32ee Binary files /dev/null and b/shared-workspace-manual/shared-workspace-manual-ss/set-access-rights.png differ diff --git a/shared-workspace-manual/shared-workspace-manual-ss/ut-logo.jpg b/shared-workspace-manual/shared-workspace-manual-ss/ut-logo.jpg new file mode 100644 index 0000000..263e752 Binary files /dev/null and b/shared-workspace-manual/shared-workspace-manual-ss/ut-logo.jpg differ diff --git a/shared-workspace-manual/shared-workspace-manual.md b/shared-workspace-manual/shared-workspace-manual.md new file mode 100644 index 0000000..a7c94cf --- /dev/null +++ b/shared-workspace-manual/shared-workspace-manual.md @@ -0,0 +1,109 @@ + + + + +
+ +
+ +
+ +

How to create a shared workspace

+ + + +This is a step-by-step guide for creating a shared workspace and granting access to it for others using the +web app crib.utwente.nl/gcp-canvas. The shared workspace can be shared with teachers, TAs, and students. +For most steps there will be a visual example provided so pay attention to a red square as it will highlight the elements important to the step. + +
    + + +
  1. +First off, open the web app crib.utwente.nl/gcp-canvas. +

    +
  2. + + +
  3. +Then, in Canvas, you will have to generate an access token. This token will allow the web app to collect information about courses for which you +have a "Teacher" role. To do this, go to canvas.utwente.nl/profile/settings and scroll down until you see a button New access token. Once the button is pressed, you will be presented with inputs for purpose and expires. For purpose you may enter 'CRIB-shared-workspace', and for expires select the next day since the token is only needed during the use of the web app. Press the button Generate token, then copy and save the token since it won't possible to get it again once you leave the page. + +

    +
  4. + + +
  5. +Now, in the web app, paste the Canvas access token in the text box and press the button Next. +
    + +
    Image 1: Paste Canvas access token in the web app.
    +
    +
  6. + + +
  7. +You will be presented with a list of courses. From this list, select the course for which you wish to create a shared workspace. +
    + +
    Image 2: Select course for which to create a shared workspace.
    +
    +
  8. + + +
  9. +Enter the name of the workspace. Under the course list there is an input where you can write the name of your shared workspace. A name will already be suggested for you but you can, of course, change it. +
    + +
    Image 3: Enter shared workspace name.
    +
    +
  10. + + +
  11. +Set access rights for each person. Under the workspace name input, there is a Users table that contains persons that are involved in the selected course. In the column Update Access, you can set the access rights for the respective person. There are three types of rights: +

    +
      +
    • +No access means that the person won't be able to access the shared workspace at all. +
    • +
    • +Read-only access only allows viewing files and folders within the shared workspace. +
    • +
    • +Full access permits the person to view and edit any file and folder within the shared workspace. +
    • +
    +
    +To make updating access rights quicker, you can use the following two features. Firstly, you can sort the table by clicking on any of the headers. For example, if you want to sort by roles to get all the teachers and TAs at the top, click on the Role header twice. Initially, the table is sorted with students on top, then, after the second click, the table is sorted with teachers and TAs at the top. The same way you can sort by Number, Name, and Access. Secondly, it is possible to assign default rights to all people with unassigned (i.e. no access) access rights by clicking the button Assign Default Access Rights under the Users table. When selected, students and observers will have read-only access while teachers, TAs, and designers will have full access. +
    + +
    Image 4: Select access rights for each person.
    +
    +
  12. + + +
  13. +Create the workspace. Once you have entered the workspace name and selected the access rights for each person, you can create the workspace by clicking Save button which is located under the Users table. Next time you or other enrolled people login to the system, the shared workspace will be visible under the shared folder. +
    + +
    Image 5: Create your shared workspace.
    +
    +
  14. + + +
  15. +Finally, you should delete the access token you generated in step 2. To do this go to canvas.utwente.nl/profile/settings and scroll down to section Approved integrations. There, you can delete the token by clicking on the bin icon. +
    + +
    Image 6: Delete access token in Canvas.
    +
    +
  16. + +
+ +
+