Last modified by bougault on 2022/03/02 11:58

From version 21.1
edited by allan
on 2020/02/26 14:25
Change comment: There is no comment for this version
To version 20.1
edited by fabricegaillard
on 2020/02/10 16:03
Change comment: Renamed back-links.

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.allan
1 +XWiki.fabricegaillard
Content
... ... @@ -17,35 +17,35 @@
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 you application to be installable by users, it needs to be registered within the [[Community Apps Catalogue>>doc:Apps.WebHome]].
21 21  
22 22  Once this simple step is complete, users will be able to install your app within their collabs.
23 23  
24 24  === Registering an application in the Catalogue ===
25 25  
26 -Navigate to the catalogue and click on **+Create App** in the top right corner. Enter a name for your app and click on **Create**.
26 +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  
28 -Fill the form with the following information:
28 +Fill the form with the following information:
29 29  
30 -* **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.
31 -* **settings URL**: the URL of the your settings management page if you have one.
32 -* **description**: a description of what your app does to help users select it.
33 -* **under development?**: should be checked if you don't want your app to be available by default by other users.
34 -* **category**: a category to help structuring the applications.
35 -* **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.
36 -* **documentation URL**: if your app has online user documentation, a link will be provided to users when they use your app.
37 -* **repository**: a URL to a public repository so users can check the sources of your app.
30 +* **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.
31 +* **settings URL**: the URL of the your settings management page if you have one.
32 +* **description**: a description of what your app does to help users select it.
33 +* **under development?**: should be checked if you don't want your app to be available by default by other users.
34 +* **category**: a category to help structuring the applications.
35 +* **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.
36 +* **documentation URL**: if your app has online user documentation, a link will be provided to users when they use your app.
37 +* **repository**: a URL to a public repository so users can check the sources of your app.
38 38  
39 -Click on **Save**. Your app is now registered and waiting for users to install it!
39 +Click on **Save**. Your app is now registered and waiting for users to install it!
40 40  
41 -=== Installing your app in a collab ===
41 +=== Installing your app in a collab ===
42 42  
43 -1. In order to install your app, you need to navigate to a collab where you have either the **editor** or **administrator** role.
44 -1. Click on **Create**. 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 app you will see are the public apps and the ones your a maintainer of.
46 -1. Select your app and click on **Save and View**.
43 +1. In order to install your app, you need to navigate to a collab where you have either the **editor** or **administrator** role.
44 +1. Click on **Create**. 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 app you will see are the public apps and the ones your a maintainer of.
46 +1. Select your app and click on **Save and View**.
47 47  
48 -You should now see how your app looks like within a collab.
48 +You should now see how your app looks like within a collab.
49 49  
50 50  == Getting your app instance context ==
51 51