Changes for page Community App Developer Guide
Last modified by bougault on 2022/03/02 11:58
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Parent
-
... ... @@ -1,1 +1,1 @@ 1 -Collabs.collab- devs.RFC.WebHome1 +Collabs.collaboratory-community-apps.WebHome - Content
-
... ... @@ -2,11 +2,9 @@ 2 2 3 3 This guide describes the steps to make this possible. 4 4 5 -{{toc numbered="true" start="2"/}} 6 - 7 7 == Becoming a contributor == 8 8 9 -The first step is for you to ** become aontributor**. 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 applications within the Community Apps Catalogue. 10 10 11 11 Send an email to [[support@humanbrainproject.eu>>mailto:support@humanbrainproject.eu]] with a short summary of your intentions. 12 12 ... ... @@ -14,17 +14,28 @@ 14 14 15 15 (% class="box infomessage" %) 16 16 ((( 17 -Only SGA2 accredited users will be automatically granted the contributor level.15 +Only SGA2 accredited users will be automatically granted the developer accreditation. 18 18 ))) 19 19 20 20 == Registering an application in the Catalogue == 21 21 22 - Collab authors findstoadd to their collabs20 +In order for you application to be installable by users, it needs to be registered within the [[Community Apps Catalogue>>doc:Apps.WebHome]]. 23 23 24 -{{error}} 25 -TODO: describe the steps to register an app in the Catalogue 26 -{{/error}} 22 +Navigate to the catalogue and click on **+Create App** in the top right corner. Enter a name for your app and click on **Create**. 27 27 24 +Fill the form with the following information: 25 + 26 +* **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. 27 +* **settings URL**: the URL of the your settings management page if you have one. 28 +* **description**: a description of what your app does to help users select it. 29 +* **under development?**: should be checked if you don't want your app to be available by default by other users. 30 +* **category**: a category to help structuring the applications. 31 +* **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. 32 +* **documentation URL**: if your app has online user documentation, a link will be provided to users when they use your app. 33 +* **repository**: a URL to a public repository so users can check the sources of your app. 34 + 35 +Click on **Save**. Your app is now registered and waiting for users to install it! 36 + 28 28 == Creating your OpenID Connect client == 29 29 30 30 The steps to create an OpenID Connect client are the following: ... ... @@ -193,3 +193,5 @@ 193 193 {{warning}} 194 194 /!\ ** Each time you modify your client, a new registration access token will be generated. You need to track of your token changes to keep access to your client. **/!\ 195 195 {{/warning}} 205 + 206 +== ==