[aerogear-dev] New docs got merged (was: Re: Docs: update on the UPS docs)

Daniel Bevenius daniel.bevenius at gmail.com
Thu Jul 31 07:28:52 EDT 2014 

I really like the table of content on the pages. Nice work guys!




On 31 July 2014 09:50, Matthias Wessendorf <matzew at apache.org> wrote:

> Hi,
>
> the new "push" landing page and restructuring went into our master branch.
> * http://staging.aerogear.org/push - the 'Learn More' now redirects to:
> ** http://staging.aerogear.org/docs/unifiedpush/
>
> That contains all UPS/Push related docs on a more centralized page.
>
> It also contains the new 'User/Reference Guide' on the UnifiedPush Server:
> http://staging.aerogear.org/docs/unifiedpush/ups_userguide/
>
> feel free to review and sent PRs/JIRAs for 'bugs' or improvements!
>
>
> Thanks!
> -Matthias
>
>
>
>
> On Wed, Jul 30, 2014 at 4:39 PM, Matthias Wessendorf <matzew at apache.org>
> wrote:
>
>> A lot of more content.
>>
>> Please review, and comment on the PR if this can be merged or not ....
>>
>>
>> On Tue, Jul 29, 2014 at 6:48 PM, Matthias Wessendorf <matzew at apache.org>
>> wrote:
>>
>>> 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 at apache.org>
>>> 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/unifiedpush/ups_userguide/index.markdown
>>>>
>>>> -M
>>>>
>>>>
>>>> On Thu, Jul 24, 2014 at 2:14 PM, Daniel Bevenius <
>>>> daniel.bevenius at gmail.com> 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 at apache.org> 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 at 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 at 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 at 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-server-userreference-guide>AeroGear
>>>>>>>>> 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 at lists.jboss.org
>>>>>> https://lists.jboss.org/mailman/listinfo/aerogear-dev
>>>>>>
>>>>>
>>>>>
>>>>> _______________________________________________
>>>>> aerogear-dev mailing list
>>>>> aerogear-dev at 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
>>>
>>
>>
>>
>> --
>> 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 at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/aerogear-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.jboss.org/pipermail/aerogear-dev/attachments/20140731/6b4cd095/attachment-0001.html

More information about the aerogear-dev mailing list