Wiki source code of Community App tutorial

Version 3.1 by chaney08 on 2021/07/07 11:12

Show last authors
1 == Community apps in collabs ==
2
3 Community apps are services developed by the EBRAINS community of users, yes, and that can be added to the navigation of any collab (by a collab's editors). For this, the app needs to be registered in a space called the "Apps Catalogue". Once the app is registered, adding such an app to a collab is as simple as creating a new Wiki page in the collab.
4
5 === Register your app in the Apps Catalogue ===
6
7 The Apps Catalogue is available at: [[https:~~/~~/wiki.ebrains.eu/bin/view/Apps/>>https://wiki.ebrains.eu/bin/view/Apps/]]
8
9 App registration is only available to members of this group: [[https:~~/~~/wiki.ebrains.eu/bin/view/Identity/#/groups/app-collaboratory-iam~~-~~-service-providers>>https://wiki.ebrains.eu/bin/view/Identity/#/groups/app-collaboratory-iam--service-providers]]
10
11 To register an app, click on "Create App", if the button does not appear, you are probably not a member of the [[group>>https://wiki.ebrains.eu/bin/view/Identity/#/groups/app-collaboratory-iam--service-providers]] previously mentioned. From that Group page, you can request to become a member which will in turn grant you permission to register apps.
12
13 (% style="text-align:center" %)
14 [[image:create-app.png||height="518" width="1250"]]
15
16 Then create a new space in the Apps Catalogue for your app using the "Community Apps" type.
17
18 (% style="text-align:center" %)
19 [[image:create-app-2.png||height="982" width="1250"]]
20
21 On the next step, fill the form to register your app. Note that only **users registered in the "maintainers" field will be able to edit this form**. Don't forget to add yourself. When done, click on the "Save & View" button; it displays a summary of information you have just filled. Your app is now available to be used in the Wiki.
22
23 ==== Add a logo (optional) ====
24
25 Some of users like to add a logo to their app. The logo is only visible when browsing the catalogue. To do so, the user has to add a PNG file attachment with the filename "logo.png" in the attachment tab at the bottom of the summary page displayed after the "Save & View" action above.
26
27 === Add an app to your collab ===
28
29 Adding an app to a collab is a simple as creating a new wiki page. As an admin or editor of a collab, a user can add a community app by clicking the "+ Create" button at the top of any wiki page, and selecting the "Community App" type.
30
31 (% style="text-align:center" %)
32 [[image:add.png||height="617" width="1250"]]
33
34 Then click the Create button and the app will have been added in the collab's navigation menu.
35
36 (% class="wikigeneratedid" id="HH4Won27tAppearinToC" %)
37