Last modified by bougault on 2022/03/02 11:58
From version 29.1
edited by mmorgan
on 2020/06/19 16:22
Change comment: Renamed back-links.
To version 32.1
edited by mmorgan
on 2020/07/16 01:51
Change comment: Renamed back-links.

Summary

Details

Page properties
Content
... ... @@ -4,25 +4,23 @@
4 4  
5 5  == Becoming a contributor ==
6 6  
7 -The first step is for you to **get the developer accreditation**. Contributors can register and manage applications within the Community Apps Catalogue.
7 +The first step is for you to **get the developer accreditation**. Contributors can register and manage apps within the Community Apps Catalogue.
8 8  
9 -Send an email to [[support@ebrains.eu>>mailto:support@ebrains.eu]] with a short summary of your intentions.
9 +Send an email to [[support@ebrains.eu>>mailto:support@ebrains.eu]] with a short motivation for your request.
10 10  
11 -The support team will apply the permissions to your user: your account will be [[upgraded with developers privileges>>doc:Collabs.collab-devs.collaboratory-v2.keycloak.user administration.WebHome]] the next time you will login.
11 +The support team will apply the permissions to your user. Your account will be [[upgraded with developer privileges>>doc:Collabs.collab-devs.collaboratory-v2.keycloak.user administration.WebHome]] the next time you login.
12 12  
13 13  (% class="box infomessage" %)
14 14  (((
15 -Only SGA2 accredited users will be automatically granted the developer accreditation.
15 +Only SGA3 accredited users will be automatically granted the developer accreditation.
16 16  )))
17 17  
18 18  == Making your app available to users ==
19 19  
20 -In order for you application to be installable by users, it needs to be registered within the [[Community Apps Catalogue>>doc:Apps.WebHome]].
20 +In order for users to install your app, it needs to be registered in the [[Community Apps Catalogue>>doc:Apps.WebHome]].
21 21  
22 -Once this simple step is complete, users will be able to install your app within their collabs.
22 +If you are dealing with private data, or your users need to be authenticated, see [[authentication and authorization in the Collaboratory.>>doc:Collabs.the-collaboratory.Technical documentation.Architecture.Permissions.Authentication & Authorisation using OIDC.WebHome]]
23 23  
24 -If you are dealing with private data, or your users need to be authenticated, see [[authentication and authorisation in the Collaboratory.>>doc:Collabs.the-collaboratory.Technical documentation.Architecture.Permissions.Authentication & Authorisation using OIDC.WebHome]]
25 -
26 26  === Registering an application in the Catalogue ===
27 27  
28 28  Navigate to the catalogue and click on **+Create App** in the top right corner. Enter a name for your app and click on **Create**.
... ... @@ -29,44 +29,44 @@
29 29  
30 30  Fill the form with the following information:
31 31  
32 -* **main URL**: the URL of the homepage of your app. This is where user will be directed when then open your app in a collab.
33 -* **settings URL**: the URL of the your settings management page if you have one.
34 -* **description**: a description of what your app does to help users select it.
35 -* **under development?**: should be checked if you don't want your app to be available by default by other users.
36 -* **category**: a category to help structuring the applications.
37 -* **maintainers**: a list of users who maintain the app. The users need to have logged in the wiki at least once to be found. Maintainers are granted the right to modify an app registration.
30 +* **main URL**: the URL of the homepage of your app. This is where the users will be directed when they open your app in a collab.
31 +* **settings URL**: the URL of your app's settings management page, if there is one.
32 +* **description**: a description of what your app does. This helps users choose the apps they install.
33 +* **under development?**: if checked, your app will not be available to other users.
34 +* **category**: a category to help structure the list of apps.
35 +* **maintainers**: a list of users who maintain the app. The users need to have logged in the wiki at least once to appear on the list. Maintainers are granted the right to modify the app's registration.
38 38  * **documentation URL**: if your app has online user documentation, a link will be provided to users when they use your app.
39 -* **repository**: a URL to a public repository so users can check the sources of your app.
37 +* **repository**: a URL to a public repository so users can access the source code of your app.
40 40  
41 41  Click on **Save**. Your app is now registered and waiting for users to install it!
42 42  
43 43  === Installing your app in a collab ===
44 44  
45 -1. In order to install your app, you need to navigate to a collab where you have either the **editor** or **administrator** role.
46 -1. Click on **Create**. Enter a title for this instance of your app and select **Community App** in the right selector.
47 -1. Click on **Create**. You will be presented with the Community App Catalogue. The app you will see are the public apps and the ones your a maintainer of.
43 +1. In order to install your app, you need to navigate to a collab where you have either the **editor** or **admin** role.
44 +1. Click on **Create** at the top right to create a new entry in the navigation pane under the current wiki page. Enter a title for this instance of your app and select **Community App** in the right selector.
45 +1. Click on **Create**. You will be presented with the Community App Catalogue. The apps you will see are the public apps and the ones for which you are a maintainer.
48 48  1. Select your app and click on **Save and View**.
49 49  
50 -You should now see how your app looks like within a collab.
48 +You should now see your app in your collab just as other users will see it.
51 51  
52 52  == Getting your app instance context ==
53 53  
54 -Instances of your applications will be installed by collab authors in many different collabs. In order to let you customise the user experience based on its context, the Collaboratory will automatically pass query parameters to your app:
52 +Instances of your apps will be installed by collab owners in many different collabs. In order to let you customise the user experience based on its context, the Collaboratory will automatically pass query parameters to your app:
55 55  
56 56  * **##clb-collab-id##**: the unique, human-readable identifier of the collab.
57 -* ##**clb-doc-path**##: the path of your app instance within the collab. If your app is at the root of a collab, this value will be empty.
55 +* ##**clb-doc-path**##: the (relative) path to your app instance within the collab. If your app is at the root of a collab, this value will be empty.
58 58  * ##**clb-doc-name**##: the name of the document where your app instance is installed.
59 59  * ##**clb-drive-id**##: the unique identifier of the drive of the collab. This id is required if you want to fetch or store documents within the drive of the collab.
60 60  
61 61  == App settings ==
62 62  
63 -The app settings are the values the collab author can modify to change the behaviour of your application within her collab.
61 +The app settings are the values the collab owners can modify to change the behaviour of your app within their collabs.
64 64  
65 65  === Writing settings ===
66 66  
67 -The Collaboratory comes with a mechanism to let your app store these settings directly in the Collaboratory.
65 +The Collaboratory comes with a mechanism to let your app store its settings directly in the Collaboratory.
68 68  
69 -In order to do that, your app needs to use the [[postMessage javascript API>>https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage]] to send the settings to store to the Collaboratory:
67 +In order to do that, your app needs to use the [[postMessage javascript API>>https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage]] to send the settings to be stored in the Collaboratory. The settings are key/value pairs as in the example below.
70 70  
71 71  {{code language="javascript"}}
72 72  window.parent.postMessage({
... ... @@ -79,10 +79,10 @@
79 79   }}, 'https://wiki.ebrains.eu');
80 80  {{/code}}
81 81  
82 -=== Fetching settings ===
80 +=== Reading settings ===
83 83  
84 84  The Collaboratory will get the settings from its key/value store and pass them to your app through query parameters.
85 85  
86 86  == Creating your OpenID Connect client ==
87 87  
88 -See the instructions [[here>>doc:.Registering an OIDC client.WebHome]].
86 +See the instructions [[here>>doc:Collabs.collaboratory-community-apps.Community App Developer Guide.1\. Registering an OIDC client.WebHome]].