<span id="mailbox-conversation">+1</span><div class="mailbox_signature">—<br>abstractj</div>
<br><br><div class="gmail_quote"><p>On Mon, Jul 21, 2014 at 1:00 PM, Matthias Wessendorf <span dir="ltr"><<a href="mailto:matzew@apache.org" target="_blank">matzew@apache.org</a>></span> wrote:<br></p><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;"><div dir="ltr">
<p style="margin-right:0px;margin-bottom:15px;margin-left:0px;color:rgb(51,51,51);font-family:Helvetica,arial,freesans,clean,sans-serif;font-size:15px;line-height:25.5px;margin-top:0px!important">Hi,</p>
<p style="margin:15px 0px;color:rgb(51,51,51);font-family:Helvetica,arial,freesans,clean,sans-serif;font-size:15px;line-height:25.5px">
right now we have a lot of different 'documentation files', like the README, some specs, and guides and tutorials.</p>
<p style="margin:15px 0px;color:rgb(51,51,51);font-family:Helvetica,arial,freesans,clean,sans-serif;font-size:15px;line-height:25.5px">
I'd like to restructure that a bit and centralize the documentation a bit.</p>
<p style="margin:15px 0px;color:rgb(51,51,51);font-family:Helvetica,arial,freesans,clean,sans-serif;font-size:15px;line-height:25.5px">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</p>
<ul class="" style="padding:0px 0px 0px 30px;margin:15px 0px;color:rgb(51,51,51);font-family:Helvetica,arial,freesans,clean,sans-serif;font-size:15px;line-height:25.5px"><li>AeroGear UnifiedPush Server User/Reference Guide</li>
<li>Tutorials</li>
</ul><h2 style="margin:1em 0px 15px;line-height:1.7;font-size:2em;padding:0px;border-bottom-width:1px;border-bottom-style:solid;border-bottom-color:rgb(238,238,238);color:rgb(51,51,51);font-family:Helvetica,arial,freesans,clean,sans-serif">
<a name="user-content-aerogear-unifiedpush-server-userreference-guide" class="" href="https://gist.github.com/matzew/333f101b036336d96891#aerogear-unifiedpush-server-userreference-guide" rel="noreferrer" style="color:rgb(65,131,196);text-decoration:none;display:block;padding-right:6px;padding-left:30px"></a>AeroGear UnifiedPush Server User/Reference Guide</h2>
<ul class="" style="padding:0px 0px 0px 30px;margin:15px 0px;color:rgb(51,51,51);font-family:Helvetica,arial,freesans,clean,sans-serif;font-size:15px;line-height:25.5px"><li>Overview<ul class="" style="padding:0px 0px 0px 30px;margin:0px"><li>some generic information</li></ul></li>
<li>Installation and configuration<ul class="" style="padding:0px 0px 0px 30px;margin:0px"><li>what's needed (e.g. JBoss and a database)</li></ul></li>
<li>Running on OpenShift<ul class="" style="padding:0px 0px 0px 30px;margin:0px"><li>using the UI on OpenShift</li>
<li>using the rhc command line</li>
</ul></li>
<li>Using the Admin UI<ul class="" style="padding:0px 0px 0px 30px;margin:0px"><li>doing an overhaul of our existing Admin UI guide (e.g. taking new screenshots and updating based on new UI features)</li>
</ul></li>
</ul><p style="margin:15px 0px;color:rgb(51,51,51);font-family:Helvetica,arial,freesans,clean,sans-serif;font-size:15px;line-height:25.5px">The format of the <em>reference guide</em> would be similar to the one from Keycloak ([2]). But... I will continue using asciidoc ;-)</p>
<p style="margin:15px 0px;color:rgb(51,51,51);font-family:Helvetica,arial,freesans,clean,sans-serif;font-size:15px;line-height:25.5px">The README will be extremely quick and simply link to the homepage ;-) After this <em>new</em> reference guide, I think some of the current specs can be removed, as the <em>reference guide</em> hopefully covers all of their content :-) </p>
<p style="margin:15px 0px;color:rgb(51,51,51);font-family:Helvetica,arial,freesans,clean,sans-serif;font-size:15px;line-height:25.5px">For the RESTful APIs, I have to look what Keycloak did to get something like:<a href="http://docs.jboss.org/keycloak/docs/1.0-beta-3/rest-api/overview-index.html" rel="noreferrer" style="color:rgb(65,131,196);text-decoration:none">http://docs.jboss.org/keycloak/docs/1.0-beta-3/rest-api/overview-index.html</a></p>
<p style="margin:15px 0px;color:rgb(51,51,51);font-family:Helvetica,arial,freesans,clean,sans-serif;font-size:15px;line-height:25.5px">After the work as been completed, I will be revisiting the specs and evaluate their need ;-)</p>
<h2 style="margin:1em 0px 15px;line-height:1.7;font-size:2em;padding:0px;border-bottom-width:1px;border-bottom-style:solid;border-bottom-color:rgb(238,238,238);color:rgb(51,51,51);font-family:Helvetica,arial,freesans,clean,sans-serif">
<a name="user-content-tutorials" class="" href="https://gist.github.com/matzew/333f101b036336d96891#tutorials" rel="noreferrer" style="color:rgb(65,131,196);text-decoration:none;display:block;padding-right:6px;padding-left:30px"></a>Tutorials</h2>
<p style="margin:15px 0px;color:rgb(51,51,51);font-family:Helvetica,arial,freesans,clean,sans-serif;font-size:15px;line-height:25.5px">This section will contain links to all the different tutorials we have:</p>
<ul class="" style="padding:0px 0px 0px 30px;margin:15px 0px;color:rgb(51,51,51);font-family:Helvetica,arial,freesans,clean,sans-serif;font-size:15px;line-height:25.5px"><li><a href="http://aerogear.org/docs/guides/aerogear-push-ios/" rel="noreferrer" style="color:rgb(65,131,196);text-decoration:none">http://aerogear.org/docs/guides/aerogear-push-ios/</a></li>
<li><a href="http://aerogear.org/docs/guides/aerogear-push-js/" rel="noreferrer" style="color:rgb(65,131,196);text-decoration:none">http://aerogear.org/docs/guides/aerogear-push-js/</a></li>
<li><a href="http://aerogear.org/docs/guides/aerogear-push-android/" rel="noreferrer" style="color:rgb(65,131,196);text-decoration:none">http://aerogear.org/docs/guides/aerogear-push-android/</a></li>
<li><a href="http://aerogear.org/docs/guides/aerogear-push-chrome/" rel="noreferrer" style="color:rgb(65,131,196);text-decoration:none">http://aerogear.org/docs/guides/aerogear-push-chrome/</a></li>
<li><a href="http://aerogear.org/docs/guides/GetStartedwithJavaSender/" rel="noreferrer" style="color:rgb(65,131,196);text-decoration:none">http://aerogear.org/docs/guides/GetStartedwithJavaSender/</a></li>
</ul><p style="margin:15px 0px;color:rgb(51,51,51);font-family:Helvetica,arial,freesans,clean,sans-serif;font-size:15px;line-height:25.5px">
For Cordova we will have one single document, instead of three:</p>
<ul class="" style="padding:0px 0px 0px 30px;margin:15px 0px;color:rgb(51,51,51);font-family:Helvetica,arial,freesans,clean,sans-serif;font-size:15px;line-height:25.5px"><li><a href="http://aerogear.org/docs/guides/aerogear-push-cordova-android/" rel="noreferrer" style="color:rgb(65,131,196);text-decoration:none">http://aerogear.org/docs/guides/aerogear-push-cordova-android/</a></li>
<li><a href="http://aerogear.org/docs/guides/aerogear-push-cordova-ios/" rel="noreferrer" style="color:rgb(65,131,196);text-decoration:none">http://aerogear.org/docs/guides/aerogear-push-cordova-ios/</a></li>
<li><a href="http://aerogear.org/docs/guides/aerogear-cordova/AerogearCordovaPush/" rel="noreferrer" style="color:rgb(65,131,196);text-decoration:none">http://aerogear.org/docs/guides/aerogear-cordova/AerogearCordovaPush/</a></li>
</ul><p style="margin:15px 0px;color:rgb(51,51,51);font-family:Helvetica,arial,freesans,clean,sans-serif;font-size:15px;line-height:25.5px">There is already a JIRA for that ([4]).</p>
<p style="margin:15px 0px;color:rgb(51,51,51);font-family:Helvetica,arial,freesans,clean,sans-serif;font-size:15px;line-height:25.5px">
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]).</p>
<p style="margin:15px 0px;color:rgb(51,51,51);font-family:Helvetica,arial,freesans,clean,sans-serif;font-size:15px;line-height:25.5px">
Greetings,<br>Matthias</p>
<p style="margin:15px 0px;color:rgb(51,51,51);font-family:Helvetica,arial,freesans,clean,sans-serif;font-size:15px;line-height:25.5px"><br></p>
<ul class="" style="padding:0px 0px 0px 30px;margin:15px 0px;color:rgb(51,51,51);font-family:Helvetica,arial,freesans,clean,sans-serif;font-size:15px;line-height:25.5px"><li>[1] <a href="http://aerogear.org/push/" rel="noreferrer" style="color:rgb(65,131,196);text-decoration:none">http://aerogear.org/push/</a>
</li>
<li>[2] <a href="http://docs.jboss.org/keycloak/docs/1.0-beta-3/userguide/html/index.html" rel="noreferrer" style="color:rgb(65,131,196);text-decoration:none">http://docs.jboss.org/keycloak/docs/1.0-beta-3/userguide/html/index.html</a>
</li>
<li>[3] <a href="http://aerogear.org/docs/guides/" rel="noreferrer" style="color:rgb(65,131,196);text-decoration:none">http://aerogear.org/docs/guides/</a>
</li>
<li>[4] <a href="https://issues.jboss.org/browse/AGPUSH-805" rel="noreferrer" style="color:rgb(65,131,196);text-decoration:none">https://issues.jboss.org/browse/AGPUSH-805</a>
</li>
</ul><div><br></div>-- <br>Matthias Wessendorf <br><br>blog: <a href="http://matthiaswessendorf.wordpress.com/">http://matthiaswessendorf.wordpress.com/</a><br>sessions: <a href="http://www.slideshare.net/mwessendorf">http://www.slideshare.net/mwessendorf</a><br>
twitter: <a href="http://twitter.com/mwessendorf">http://twitter.com/mwessendorf</a>
</div></blockquote></div><br>