Hi, right now we have a lot of different 'documentation files', like the README, some specs, and guides and tutorials. I'd like to restructure that a bit and centralize the documentation a bit. On the "push" landing page ([1]), I'd like to change the "Lean More" link to a new page that has all the UPS centric documentations - AeroGear UnifiedPush Server User/Reference Guide - Tutorials <https://gist.github.com/matzew/333f101b036336d96891#aerogear-unifiedpush-... UnifiedPush Server User/Reference Guide - Overview - some generic information - Installation and configuration - what's needed (e.g. JBoss and a database) - Running on OpenShift - using the UI on OpenShift - using the rhc command line - Using the Admin UI - doing an overhaul of our existing Admin UI guide (e.g. taking new screenshots and updating based on new UI features) The format of the *reference guide* would be similar to the one from Keycloak ([2]). But... I will continue using asciidoc ;-) The README will be extremely quick and simply link to the homepage ;-) After this *new* reference guide, I think some of the current specs can be removed, as the *reference guide* hopefully covers all of their content :-) For the RESTful APIs, I have to look what Keycloak did to get something like: http://docs.jboss.org/keycloak/docs/1.0-beta-3/rest-api/overview-index.html After the work as been completed, I will be revisiting the specs and evaluate their need ;-) <https://gist.github.com/matzew/333f101b036336d96891#tutorials>Tutorials This section will contain links to all the different tutorials we have: - http://aerogear.org/docs/guides/aerogear-push-ios/ - http://aerogear.org/docs/guides/aerogear-push-js/ - http://aerogear.org/docs/guides/aerogear-push-android/ - http://aerogear.org/docs/guides/aerogear-push-chrome/ - http://aerogear.org/docs/guides/GetStartedwithJavaSender/ For Cordova we will have one single document, instead of three: - http://aerogear.org/docs/guides/aerogear-push-cordova-android/ - http://aerogear.org/docs/guides/aerogear-push-cordova-ios/ - http://aerogear.org/docs/guides/aerogear-cordova/AerogearCordovaPush/ There is already a JIRA for that ([4]). To make it more clear (or clean?), I will remove the UPS/Push related docs from our guides ([3]) and replace all those links by a single link to the above mentioned new page (also referenced from [1]). Greetings, Matthias - [1] http://aerogear.org/push/ - [2] http://docs.jboss.org/keycloak/docs/1.0-beta-3/userguide/html/index.html - [3] http://aerogear.org/docs/guides/ - [4] https://issues.jboss.org/browse/AGPUSH-805 -- Matthias Wessendorf blog: http://matthiaswessendorf.wordpress.com/ sessions: http://www.slideshare.net/mwessendorf twitter: http://twitter.com/mwessendorf

+9001 On Mon, Jul 21, 2014 at 1:12 PM, Bruno Oliveira <bruno(a)abstractj.org&gt; wrote: > +1 > — > abstractj > > > On Mon, Jul 21, 2014 at 1:00 PM, Matthias Wessendorf <matzew(a)apache.org&gt; > wrote: > >> Hi, >> >> right now we have a lot of different 'documentation files', like the >> README, some specs, and guides and tutorials. >> >> I'd like to restructure that a bit and centralize the documentation a >> bit. >> >> On the "push" landing page ([1]), I'd like to change the "Lean More" >> link to a new page that has all the UPS centric documentations >> >> - AeroGear UnifiedPush Server User/Reference Guide >> - Tutorials >> >> >> <https://gist.github.com/matzew/333f101b036336d96891#aerogear-unifiedpush-... >> UnifiedPush Server User/Reference Guide >> >> - Overview >> - some generic information >> - Installation and configuration >> - what's needed (e.g. JBoss and a database) >> - Running on OpenShift >> - using the UI on OpenShift >> - using the rhc command line >> - Using the Admin UI >> - doing an overhaul of our existing Admin UI guide (e.g. taking >> new screenshots and updating based on new UI features) >> >> The format of the *reference guide* would be similar to the one from >> Keycloak ([2]). But... I will continue using asciidoc ;-) >> >> The README will be extremely quick and simply link to the homepage ;-) >> After this *new* reference guide, I think some of the current specs can >> be removed, as the *reference guide* hopefully covers all of their >> content :-) >> >> For the RESTful APIs, I have to look what Keycloak did to get something >> like: >> http://docs.jboss.org/keycloak/docs/1.0-beta-3/rest-api/overview-index.html >> >> After the work as been completed, I will be revisiting the specs and >> evaluate their need ;-) >> <https://gist.github.com/matzew/333f101b036336d96891#tutorials> >> Tutorials >> >> This section will contain links to all the different tutorials we have: >> >> - http://aerogear.org/docs/guides/aerogear-push-ios/ >> - http://aerogear.org/docs/guides/aerogear-push-js/ >> - http://aerogear.org/docs/guides/aerogear-push-android/ >> - http://aerogear.org/docs/guides/aerogear-push-chrome/ >> - http://aerogear.org/docs/guides/GetStartedwithJavaSender/ >> >> For Cordova we will have one single document, instead of three: >> >> - http://aerogear.org/docs/guides/aerogear-push-cordova-android/ >> - http://aerogear.org/docs/guides/aerogear-push-cordova-ios/ >> - >> http://aerogear.org/docs/guides/aerogear-cordova/AerogearCordovaPush/ >> >> There is already a JIRA for that ([4]). >> >> To make it more clear (or clean?), I will remove the UPS/Push related >> docs from our guides ([3]) and replace all those links by a single link to >> the above mentioned new page (also referenced from [1]). >> >> Greetings, >> Matthias >> >> >> >> - [1] http://aerogear.org/push/ >> - [2] >> http://docs.jboss.org/keycloak/docs/1.0-beta-3/userguide/html/index.html >> - [3] http://aerogear.org/docs/guides/ >> - [4] https://issues.jboss.org/browse/AGPUSH-805 >> >> >> -- >> Matthias Wessendorf >> >> blog: http://matthiaswessendorf.wordpress.com/ >> sessions: http://www.slideshare.net/mwessendorf >> twitter: http://twitter.com/mwessendorf >> > > > _______________________________________________ > aerogear-dev mailing list > aerogear-dev(a)lists.jboss.org > https://lists.jboss.org/mailman/listinfo/aerogear-dev > _______________________________________________ aerogear-dev mailing list aerogear-dev(a)lists.jboss.org https://lists.jboss.org/mailman/listinfo/aerogear-dev

I think Matthias' suggestions for the UPS content look great! I think having the UPS content on one page is ideal. I came up with 4 categories: * UPS Guide, * Tutorials for adding and testing various application variants, * Tutorial for further developing push functionality in applications, * Reference material (APIs). I think the only real difference here from Matthias' plan is that I would separate the existing tutorials into 2 distinct categories. I've included ideas about the content for each of these categories/docs below. I've tried to fill out the table of contents for the docs from what Matthias listed and the docs on the site. As Matthias said, the info in the specs will likely be included in the UPS Guide so they'll become obsolete. Please let me know what you think and how I can help further. Thanks, Michelle Unified Push Server Guide 1. Overview 1.1 About the Unified Push Server [Overview only: What it is, What it consists of, What makes it different from other push servers] 1.2 Use Cases of the Unified Push Server [Who uses it, When to use it, Why use it] 1.3 Useful Terminology [Glossary] 1.4 How the Unified Push Server Works [The details: What is the workflow for Admins and Devs using it? How do apps interact with it; basically setting out the tasks that need to be done and that come in the remaining chps of this guide] 2. Installing the Unified Push Server on JBoss (Wildfly? other non-JBoss servers? make generic server?) [When would choose this option, Components needed] [Steps for installing and running] [Any special JBoss configuration needed or options available] 3. Installing the Unified Push Server on OpenShift [When would choose this option, Components needed] [Steps for installing and running: OpenShift UI, rhc CLI, JBoss Tools OpenShift Tools?] [Any special OpenShift configuration needed or options available] 4. Administering the Unified Push Server Console [Chapter for Admins, common info regardless of underlying UPS hosting sever type] [Overview: What is the console, when to use, who uses] [How to access] [Features: Enroll/remove console users (devs, admins, viewers), ..., (can also complete UPS actions relating to specific apps but see next chp for that info)] [Any console customization? change password, ...] [Additional security?] 5. Configuring and Managing Applications that use the Unified Push Server [Chapter for Devs; Admins can also do the tasks in the console] [Overview of process: register app and variants with server, include server specific info in app, host app for users to install, apps can send automated push notification requests to server using JavaSender API or can use unified push server to send manual push notifications] [How to register app and variants with server, add pointers to any variant prerequisites like needing certificates for Apple, can give more extended info in Tutorials**] [How to configure app source code so as to use server - keep it minimal and focused on which info needed from UPS to be added to app source code, can give more extended info in Tutorials**] [How to send push notification, disable push notifications for selected installs, ...] [For examples of this in action see Tutorials**] 6. More Information [Info on adding and testing push notifications on various Application variants, see Tutorials**] [Info on developing applications that use automated push notifications, see Tutorial"] [Info on push and push server APIs, see blah page for a linked lists of APIs] **Tutorials: Adding and Testing Push Notifications for Applications 1. Introduction [Each variant has different requirements in terms of preconfiguration and where in source code to add push server info] [Tutorials look at each variant and walk through an example of configuring push notifications for each variant] [Assumes push server is running and dev enrolled to use it] 2. ANPs http://aerogear.org/docs/guides/aerogear-push-ios/ 3. GCM http://aerogear.org/docs/guides/aerogear-push-android/ http://aerogear.org/docs/guides/aerogear-push-chrome/ 4. Cordova http://aerogear.org/docs/guides/aerogear-push-cordova-ios/ http://aerogear.org/docs/guides/aerogear-push-cordova-android/ http://aerogear.org/docs/guides/aerogear-cordova/AerogearCordovaPush/ 5. SimplePush http://aerogear.org/docs/guides/aerogear-push-js/ "Tutorial: Developing Push Notification Applications http://aerogear.org/docs/guides/GetStartedwithJavaSender/ Reference: Push APIs JavaSender ...? _______________________________________________ aerogear-dev mailing list aerogear-dev(a)lists.jboss.org https://lists.jboss.org/mailman/listinfo/aerogear-dev

Hi, right now we have a lot of different 'documentation files', like the README, some specs, and guides and tutorials. I'd like to restructure that a bit and centralize the documentation a bit. On the "push" landing page ([1]), I'd like to change the "Lean More" link to a new page that has all the UPS centric documentations - AeroGear UnifiedPush Server User/Reference Guide - Tutorials <https://gist.github.com/matzew/333f101b036336d96891#aerogear-unifiedpush-... UnifiedPush Server User/Reference Guide - Overview - some generic information - Installation and configuration - what's needed (e.g. JBoss and a database) - Running on OpenShift - using the UI on OpenShift - using the rhc command line - Using the Admin UI - doing an overhaul of our existing Admin UI guide (e.g. taking new screenshots and updating based on new UI features) The format of the *reference guide* would be similar to the one from Keycloak ([2]). But... I will continue using asciidoc ;-) The README will be extremely quick and simply link to the homepage ;-) After this *new* reference guide, I think some of the current specs can be removed, as the *reference guide* hopefully covers all of their content :-) For the RESTful APIs, I have to look what Keycloak did to get something like: http://docs.jboss.org/keycloak/docs/1.0-beta-3/rest-api/overview-index.html After the work as been completed, I will be revisiting the specs and evaluate their need ;-) <https://gist.github.com/matzew/333f101b036336d96891#tutorials>Tutorials This section will contain links to all the different tutorials we have: - http://aerogear.org/docs/guides/aerogear-push-ios/ - http://aerogear.org/docs/guides/aerogear-push-js/ - http://aerogear.org/docs/guides/aerogear-push-android/ - http://aerogear.org/docs/guides/aerogear-push-chrome/ - http://aerogear.org/docs/guides/GetStartedwithJavaSender/ For Cordova we will have one single document, instead of three: - http://aerogear.org/docs/guides/aerogear-push-cordova-android/ - http://aerogear.org/docs/guides/aerogear-push-cordova-ios/ - http://aerogear.org/docs/guides/aerogear-cordova/AerogearCordovaPush/ There is already a JIRA for that ([4]). To make it more clear (or clean?), I will remove the UPS/Push related docs from our guides ([3]) and replace all those links by a single link to the above mentioned new page (also referenced from [1]). Greetings, Matthias - [1] http://aerogear.org/push/ - [2] http://docs.jboss.org/keycloak/docs/1.0-beta-3/userguide/html/index.html - [3] http://aerogear.org/docs/guides/ - [4] https://issues.jboss.org/browse/AGPUSH-805 -- Matthias Wessendorf blog: http://matthiaswessendorf.wordpress.com/ sessions: http://www.slideshare.net/mwessendorf twitter: http://twitter.com/mwessendorf

Here is the TOC that I have in mind (and started to work on): UnifiedPush Server User Guide - Overview - About the UnifiedPush Server - Use-cases and scenarios - Useful Terminology - How the UnifiedPush Server Works - Installation and configuration - The WAR file distribution - setup and configure a database - deploy the WAR files - Running on OpenShift - create an instance using OpenShift's Web UI - create an instance using OpenShift's command line interface - Using the Admin UI - Administering the UnifiedPush Server Console - Configuring and Managing Applications that use the UnifiedPush Server - Preparing mobile devices to be connected with the UnifiedPush Server - Sending Push Notifications - Next steps - TBD: Links to tutorials and specs (some specs might go away) On Thu, Jul 24, 2014 at 11:26 AM, Matthias Wessendorf <matzew(a)apache.org&gt; wrote: > Before actually starting with the (initial) rewrite of the UPS guide (as > I outlined), I did the re-org of the UPS content. > > Please review: > https://github.com/aerogear/aerogear.org/pull/327 > > > > > On Mon, Jul 21, 2014 at 5:59 PM, Matthias Wessendorf <matzew(a)apache.org&gt; > wrote: > >> Hi, >> >> right now we have a lot of different 'documentation files', like the >> README, some specs, and guides and tutorials. >> >> I'd like to restructure that a bit and centralize the documentation a >> bit. >> >> On the "push" landing page ([1]), I'd like to change the "Lean More" >> link to a new page that has all the UPS centric documentations >> >> - AeroGear UnifiedPush Server User/Reference Guide >> - Tutorials >> >> >> <https://gist.github.com/matzew/333f101b036336d96891#aerogear-unifiedpush-... >> UnifiedPush Server User/Reference Guide >> >> - Overview >> - some generic information >> - Installation and configuration >> - what's needed (e.g. JBoss and a database) >> - Running on OpenShift >> - using the UI on OpenShift >> - using the rhc command line >> - Using the Admin UI >> - doing an overhaul of our existing Admin UI guide (e.g. taking >> new screenshots and updating based on new UI features) >> >> The format of the *reference guide* would be similar to the one from >> Keycloak ([2]). But... I will continue using asciidoc ;-) >> >> The README will be extremely quick and simply link to the homepage ;-) >> After this *new* reference guide, I think some of the current specs can >> be removed, as the *reference guide* hopefully covers all of their >> content :-) >> >> For the RESTful APIs, I have to look what Keycloak did to get something >> like: >> http://docs.jboss.org/keycloak/docs/1.0-beta-3/rest-api/overview-index.html >> >> After the work as been completed, I will be revisiting the specs and >> evaluate their need ;-) >> <https://gist.github.com/matzew/333f101b036336d96891#tutorials> >> Tutorials >> >> This section will contain links to all the different tutorials we have: >> >> - http://aerogear.org/docs/guides/aerogear-push-ios/ >> - http://aerogear.org/docs/guides/aerogear-push-js/ >> - http://aerogear.org/docs/guides/aerogear-push-android/ >> - http://aerogear.org/docs/guides/aerogear-push-chrome/ >> - http://aerogear.org/docs/guides/GetStartedwithJavaSender/ >> >> For Cordova we will have one single document, instead of three: >> >> - http://aerogear.org/docs/guides/aerogear-push-cordova-android/ >> - http://aerogear.org/docs/guides/aerogear-push-cordova-ios/ >> - >> http://aerogear.org/docs/guides/aerogear-cordova/AerogearCordovaPush/ >> >> There is already a JIRA for that ([4]). >> >> To make it more clear (or clean?), I will remove the UPS/Push related >> docs from our guides ([3]) and replace all those links by a single link to >> the above mentioned new page (also referenced from [1]). >> >> Greetings, >> Matthias >> >> >> >> - [1] http://aerogear.org/push/ >> - [2] >> http://docs.jboss.org/keycloak/docs/1.0-beta-3/userguide/html/index.html >> - [3] http://aerogear.org/docs/guides/ >> - [4] https://issues.jboss.org/browse/AGPUSH-805 >> >> >> -- >> Matthias Wessendorf >> >> blog: http://matthiaswessendorf.wordpress.com/ >> sessions: http://www.slideshare.net/mwessendorf >> twitter: http://twitter.com/mwessendorf >> > > > > -- > Matthias Wessendorf > > blog: http://matthiaswessendorf.wordpress.com/ > sessions: http://www.slideshare.net/mwessendorf > twitter: http://twitter.com/mwessendorf > -- Matthias Wessendorf blog: http://matthiaswessendorf.wordpress.com/ sessions: http://www.slideshare.net/mwessendorf twitter: http://twitter.com/mwessendorf

Looks good! perhaps change: Configuring and Managing Applications that use the UnifiedPush Server -> Configuring and managing applications that use the UnifiedPush Server On 24 July 2014 13:32, Matthias Wessendorf <matzew(a)apache.org&gt; wrote: > update: > > > UnifiedPush Server User Guide > > - Overview > - About the UnifiedPush Server > - Use-cases and scenarios > - Useful Terminology > - How the UnifiedPush Server Works > - Installation and configuration > - The WAR file distribution > - setup and configure a database > - deploy the WAR files > - Running on OpenShift > - create an instance using OpenShift's Web UI > - create an instance using OpenShift's command line interface > - Using the Admin UI > - Administering the UnifiedPush Server Console > - Configuring and Managing Applications that use the UnifiedPush > Server > - Preparing mobile devices to be connected with the UnifiedPush > Server > - Sending Push Notifications > - Preparing backends to send Push Notifications > - Next steps > - TBD: Links to tutorials and specs (some specs might go away) > > > > > > > > On Thu, Jul 24, 2014 at 1:29 PM, Matthias Wessendorf <matzew(a)apache.org&gt; > wrote: > >> Here is the TOC that I have in mind (and started to work on): >> >> UnifiedPush Server User Guide >> >> - Overview >> - About the UnifiedPush Server >> - Use-cases and scenarios >> - Useful Terminology >> - How the UnifiedPush Server Works >> - Installation and configuration >> - The WAR file distribution >> - setup and configure a database >> - deploy the WAR files >> - Running on OpenShift >> - create an instance using OpenShift's Web UI >> - create an instance using OpenShift's command line interface >> - Using the Admin UI >> - Administering the UnifiedPush Server Console >> - Configuring and Managing Applications that use the UnifiedPush >> Server >> - Preparing mobile devices to be connected with the UnifiedPush >> Server >> - Sending Push Notifications >> - Next steps >> - TBD: Links to tutorials and specs (some specs might go away) >> >> >> >> >> >> On Thu, Jul 24, 2014 at 11:26 AM, Matthias Wessendorf <matzew(a)apache.org >> > wrote: >> >>> Before actually starting with the (initial) rewrite of the UPS guide >>> (as I outlined), I did the re-org of the UPS content. >>> >>> Please review: >>> https://github.com/aerogear/aerogear.org/pull/327 >>> >>> >>> >>> >>> On Mon, Jul 21, 2014 at 5:59 PM, Matthias Wessendorf <matzew(a)apache.org >>> > wrote: >>> >>>> Hi, >>>> >>>> right now we have a lot of different 'documentation files', like the >>>> README, some specs, and guides and tutorials. >>>> >>>> I'd like to restructure that a bit and centralize the documentation a >>>> bit. >>>> >>>> On the "push" landing page ([1]), I'd like to change the "Lean More" >>>> link to a new page that has all the UPS centric documentations >>>> >>>> - AeroGear UnifiedPush Server User/Reference Guide >>>> - Tutorials >>>> >>>> >>>> <https://gist.github.com/matzew/333f101b036336d96891#aerogear-unifiedpush-... >>>> UnifiedPush Server User/Reference Guide >>>> >>>> - Overview >>>> - some generic information >>>> - Installation and configuration >>>> - what's needed (e.g. JBoss and a database) >>>> - Running on OpenShift >>>> - using the UI on OpenShift >>>> - using the rhc command line >>>> - Using the Admin UI >>>> - doing an overhaul of our existing Admin UI guide (e.g. taking >>>> new screenshots and updating based on new UI features) >>>> >>>> The format of the *reference guide* would be similar to the one from >>>> Keycloak ([2]). But... I will continue using asciidoc ;-) >>>> >>>> The README will be extremely quick and simply link to the homepage ;-) >>>> After this *new* reference guide, I think some of the current specs >>>> can be removed, as the *reference guide* hopefully covers all of >>>> their content :-) >>>> >>>> For the RESTful APIs, I have to look what Keycloak did to get >>>> something like: >>>> http://docs.jboss.org/keycloak/docs/1.0-beta-3/rest-api/overview-index.html >>>> >>>> After the work as been completed, I will be revisiting the specs and >>>> evaluate their need ;-) >>>> <https://gist.github.com/matzew/333f101b036336d96891#tutorials> >>>> Tutorials >>>> >>>> This section will contain links to all the different tutorials we have: >>>> >>>> - http://aerogear.org/docs/guides/aerogear-push-ios/ >>>> - http://aerogear.org/docs/guides/aerogear-push-js/ >>>> - http://aerogear.org/docs/guides/aerogear-push-android/ >>>> - http://aerogear.org/docs/guides/aerogear-push-chrome/ >>>> - http://aerogear.org/docs/guides/GetStartedwithJavaSender/ >>>> >>>> For Cordova we will have one single document, instead of three: >>>> >>>> - http://aerogear.org/docs/guides/aerogear-push-cordova-android/ >>>> - http://aerogear.org/docs/guides/aerogear-push-cordova-ios/ >>>> - >>>> http://aerogear.org/docs/guides/aerogear-cordova/AerogearCordovaPush/ >>>> >>>> There is already a JIRA for that ([4]). >>>> >>>> To make it more clear (or clean?), I will remove the UPS/Push related >>>> docs from our guides ([3]) and replace all those links by a single link to >>>> the above mentioned new page (also referenced from [1]). >>>> >>>> Greetings, >>>> Matthias >>>> >>>> >>>> >>>> - [1] http://aerogear.org/push/ >>>> - [2] >>>> http://docs.jboss.org/keycloak/docs/1.0-beta-3/userguide/html/index.html >>>> - [3] http://aerogear.org/docs/guides/ >>>> - [4] https://issues.jboss.org/browse/AGPUSH-805 >>>> >>>> >>>> -- >>>> Matthias Wessendorf >>>> >>>> blog: http://matthiaswessendorf.wordpress.com/ >>>> sessions: http://www.slideshare.net/mwessendorf >>>> twitter: http://twitter.com/mwessendorf >>>> >>> >>> >>> >>> -- >>> Matthias Wessendorf >>> >>> blog: http://matthiaswessendorf.wordpress.com/ >>> sessions: http://www.slideshare.net/mwessendorf >>> twitter: http://twitter.com/mwessendorf >>> >> >> >> >> -- >> Matthias Wessendorf >> >> blog: http://matthiaswessendorf.wordpress.com/ >> sessions: http://www.slideshare.net/mwessendorf >> twitter: http://twitter.com/mwessendorf >> > > > > -- > Matthias Wessendorf > > blog: http://matthiaswessendorf.wordpress.com/ > sessions: http://www.slideshare.net/mwessendorf > twitter: http://twitter.com/mwessendorf > > _______________________________________________ > aerogear-dev mailing list > aerogear-dev(a)lists.jboss.org > https://lists.jboss.org/mailman/listinfo/aerogear-dev > _______________________________________________ aerogear-dev mailing list aerogear-dev(a)lists.jboss.org https://lists.jboss.org/mailman/listinfo/aerogear-dev

Here is a first PR for it: https://github.com/aerogear/aerogear.org/pull/333 as noted, still WIP - but it is getting there On Thu, Jul 24, 2014 at 3:25 PM, Matthias Wessendorf <matzew(a)apache.org&gt; wrote: > Thanks Dan! > > > FYI - the draft of the TOC (and soon content) lives in this branch: > > > https://github.com/aerogear/aerogear.org/blob/NewUPS_Guide/docs/unifiedpu... > > -M > > > On Thu, Jul 24, 2014 at 2:14 PM, Daniel Bevenius < > daniel.bevenius(a)gmail.com&gt; wrote: > >> Looks good! >> perhaps change: Configuring and Managing Applications that use the >> UnifiedPush Server -> Configuring and managing applications that use >> the UnifiedPush Server >> >> >> >> On 24 July 2014 13:32, Matthias Wessendorf <matzew(a)apache.org&gt; wrote: >> >>> update: >>> >>> >>> UnifiedPush Server User Guide >>> >>> - Overview >>> - About the UnifiedPush Server >>> - Use-cases and scenarios >>> - Useful Terminology >>> - How the UnifiedPush Server Works >>> - Installation and configuration >>> - The WAR file distribution >>> - setup and configure a database >>> - deploy the WAR files >>> - Running on OpenShift >>> - create an instance using OpenShift's Web UI >>> - create an instance using OpenShift's command line interface >>> - Using the Admin UI >>> - Administering the UnifiedPush Server Console >>> - Configuring and Managing Applications that use the UnifiedPush >>> Server >>> - Preparing mobile devices to be connected with the UnifiedPush >>> Server >>> - Sending Push Notifications >>> - Preparing backends to send Push Notifications >>> - Next steps >>> - TBD: Links to tutorials and specs (some specs might go away) >>> >>> >>> >>> >>> >>> >>> >>> On Thu, Jul 24, 2014 at 1:29 PM, Matthias Wessendorf <matzew(a)apache.org >>> > wrote: >>> >>>> Here is the TOC that I have in mind (and started to work on): >>>> >>>> UnifiedPush Server User Guide >>>> >>>> - Overview >>>> - About the UnifiedPush Server >>>> - Use-cases and scenarios >>>> - Useful Terminology >>>> - How the UnifiedPush Server Works >>>> - Installation and configuration >>>> - The WAR file distribution >>>> - setup and configure a database >>>> - deploy the WAR files >>>> - Running on OpenShift >>>> - create an instance using OpenShift's Web UI >>>> - create an instance using OpenShift's command line interface >>>> - Using the Admin UI >>>> - Administering the UnifiedPush Server Console >>>> - Configuring and Managing Applications that use the >>>> UnifiedPush Server >>>> - Preparing mobile devices to be connected with the UnifiedPush >>>> Server >>>> - Sending Push Notifications >>>> - Next steps >>>> - TBD: Links to tutorials and specs (some specs might go away) >>>> >>>> >>>> >>>> >>>> >>>> On Thu, Jul 24, 2014 at 11:26 AM, Matthias Wessendorf < >>>> matzew(a)apache.org&gt; wrote: >>>> >>>>> Before actually starting with the (initial) rewrite of the UPS guide >>>>> (as I outlined), I did the re-org of the UPS content. >>>>> >>>>> Please review: >>>>> https://github.com/aerogear/aerogear.org/pull/327 >>>>> >>>>> >>>>> >>>>> >>>>> On Mon, Jul 21, 2014 at 5:59 PM, Matthias Wessendorf < >>>>> matzew(a)apache.org&gt; wrote: >>>>> >>>>>> Hi, >>>>>> >>>>>> right now we have a lot of different 'documentation files', like the >>>>>> README, some specs, and guides and tutorials. >>>>>> >>>>>> I'd like to restructure that a bit and centralize the documentation >>>>>> a bit. >>>>>> >>>>>> On the "push" landing page ([1]), I'd like to change the "Lean More" >>>>>> link to a new page that has all the UPS centric documentations >>>>>> >>>>>> - AeroGear UnifiedPush Server User/Reference Guide >>>>>> - Tutorials >>>>>> >>>>>> >>>>>> <https://gist.github.com/matzew/333f101b036336d96891#aerogear-unifiedpush-... >>>>>> UnifiedPush Server User/Reference Guide >>>>>> >>>>>> - Overview >>>>>> - some generic information >>>>>> - Installation and configuration >>>>>> - what's needed (e.g. JBoss and a database) >>>>>> - Running on OpenShift >>>>>> - using the UI on OpenShift >>>>>> - using the rhc command line >>>>>> - Using the Admin UI >>>>>> - doing an overhaul of our existing Admin UI guide (e.g. >>>>>> taking new screenshots and updating based on new UI features) >>>>>> >>>>>> The format of the *reference guide* would be similar to the one >>>>>> from Keycloak ([2]). But... I will continue using asciidoc ;-) >>>>>> >>>>>> The README will be extremely quick and simply link to the homepage >>>>>> ;-) After this *new* reference guide, I think some of the current >>>>>> specs can be removed, as the *reference guide* hopefully covers all >>>>>> of their content :-) >>>>>> >>>>>> For the RESTful APIs, I have to look what Keycloak did to get >>>>>> something like: >>>>>> http://docs.jboss.org/keycloak/docs/1.0-beta-3/rest-api/overview-index.html >>>>>> >>>>>> After the work as been completed, I will be revisiting the specs and >>>>>> evaluate their need ;-) >>>>>> <https://gist.github.com/matzew/333f101b036336d96891#tutorials> >>>>>> Tutorials >>>>>> >>>>>> This section will contain links to all the different tutorials we >>>>>> have: >>>>>> >>>>>> - http://aerogear.org/docs/guides/aerogear-push-ios/ >>>>>> - http://aerogear.org/docs/guides/aerogear-push-js/ >>>>>> - http://aerogear.org/docs/guides/aerogear-push-android/ >>>>>> - http://aerogear.org/docs/guides/aerogear-push-chrome/ >>>>>> - http://aerogear.org/docs/guides/GetStartedwithJavaSender/ >>>>>> >>>>>> For Cordova we will have one single document, instead of three: >>>>>> >>>>>> - http://aerogear.org/docs/guides/aerogear-push-cordova-android/ >>>>>> - http://aerogear.org/docs/guides/aerogear-push-cordova-ios/ >>>>>> - >>>>>> http://aerogear.org/docs/guides/aerogear-cordova/AerogearCordovaPush/ >>>>>> >>>>>> There is already a JIRA for that ([4]). >>>>>> >>>>>> To make it more clear (or clean?), I will remove the UPS/Push >>>>>> related docs from our guides ([3]) and replace all those links by a single >>>>>> link to the above mentioned new page (also referenced from [1]). >>>>>> >>>>>> Greetings, >>>>>> Matthias >>>>>> >>>>>> >>>>>> >>>>>> - [1] http://aerogear.org/push/ >>>>>> - [2] >>>>>> http://docs.jboss.org/keycloak/docs/1.0-beta-3/userguide/html/index.html >>>>>> - [3] http://aerogear.org/docs/guides/ >>>>>> - [4] https://issues.jboss.org/browse/AGPUSH-805 >>>>>> >>>>>> >>>>>> -- >>>>>> Matthias Wessendorf >>>>>> >>>>>> blog: http://matthiaswessendorf.wordpress.com/ >>>>>> sessions: http://www.slideshare.net/mwessendorf >>>>>> twitter: http://twitter.com/mwessendorf >>>>>> >>>>> >>>>> >>>>> >>>>> -- >>>>> Matthias Wessendorf >>>>> >>>>> blog: http://matthiaswessendorf.wordpress.com/ >>>>> sessions: http://www.slideshare.net/mwessendorf >>>>> twitter: http://twitter.com/mwessendorf >>>>> >>>> >>>> >>>> >>>> -- >>>> Matthias Wessendorf >>>> >>>> blog: http://matthiaswessendorf.wordpress.com/ >>>> sessions: http://www.slideshare.net/mwessendorf >>>> twitter: http://twitter.com/mwessendorf >>>> >>> >>> >>> >>> -- >>> Matthias Wessendorf >>> >>> blog: http://matthiaswessendorf.wordpress.com/ >>> sessions: http://www.slideshare.net/mwessendorf >>> twitter: http://twitter.com/mwessendorf >>> >>> _______________________________________________ >>> aerogear-dev mailing list >>> aerogear-dev(a)lists.jboss.org >>> https://lists.jboss.org/mailman/listinfo/aerogear-dev >>> >> >> >> _______________________________________________ >> aerogear-dev mailing list >> aerogear-dev(a)lists.jboss.org >> https://lists.jboss.org/mailman/listinfo/aerogear-dev >> > > > > -- > Matthias Wessendorf > > blog: http://matthiaswessendorf.wordpress.com/ > sessions: http://www.slideshare.net/mwessendorf > twitter: http://twitter.com/mwessendorf > -- Matthias Wessendorf blog: http://matthiaswessendorf.wordpress.com/ sessions: http://www.slideshare.net/mwessendorf twitter: http://twitter.com/mwessendorf