[aerogear-dev] Aerogear documentation navigation

Paul Wright pwright at redhat.com
Mon Aug 14 05:46:44 EDT 2017


Thanks,

I could just create a PR for this particular issue, or ...

how about a refresh/doc review, and replacing jekyll with asciibinder 
<http://www.asciibinder.org/>:

* Allow us publish multiple branches of docs (releases)

* Allow contributors familiar with asciibinder, eg openshift 
contributors <https://github.com/openshift/openshift-docs>  to contribute

* Allow me sync with downstream docs in a consistent process (distros)

Ok, that last one is just for me, but it should be possible to keep the 
aerogear look and feel, but provide a better experience for users. 
asciibinder is designed by red hatters for multiple distros of 
documentation, and is what openshift use:

https://docs.openshift.com/container-platform/3.6/welcome/index.html

Anyone object if we go down this road? (again, there might be unique 
feature of the current website that I'm not familiar with)

thanks,

Paul



On 08/11/2017 04:16 PM, Summers Pittman wrote:
> Or feel free to make suggestions, the reference docs and guides 
> probably need a fresh critical eye anyway.
>
> On Fri, Aug 11, 2017 at 7:29 AM, Matthias Wessendorf 
> <matzew at apache.org <mailto:matzew at apache.org>> wrote:
>
>     Hey Paul,
>
>     feel free to send a PR for this. Thx!
>
>     On Fri, Aug 11, 2017 at 12:26 PM, Paul Wright <pwright at redhat.com
>     <mailto:pwright at redhat.com>> wrote:
>
>         Excuse my ignorance, but I've been caught a few times by the
>         docs navigation on aerogear.org <http://aerogear.org>,
>         specifically, I click 'Docs' and then cannot find any guides:
>
>
>
>         Ok, it does say this is 'API Doc and Specs' in low contrast
>         text and there are links to 'Guides
>         <https://aerogear.org/getstarted/guides>' if I scroll to the
>         bottom of the page, but is this how we want it to work?
>
>         That's where my ignorance comes in, is there some plan here
>         that I'm not aware of, or should I just go ahead and make a PR?
>
>         thanks,
>         Paul
>
>
>
>         _______________________________________________
>         aerogear-dev mailing list
>         aerogear-dev at lists.jboss.org <mailto:aerogear-dev at lists.jboss.org>
>         https://lists.jboss.org/mailman/listinfo/aerogear-dev
>         <https://lists.jboss.org/mailman/listinfo/aerogear-dev>
>
>
>
>
>     -- 
>     Matthias Wessendorf
>
>     blog: http://matthiaswessendorf.wordpress.com/
>     <http://matthiaswessendorf.wordpress.com/>
>     twitter: http://twitter.com/mwessendorf
>
>     _______________________________________________
>     aerogear-dev mailing list
>     aerogear-dev at lists.jboss.org <mailto:aerogear-dev at lists.jboss.org>
>     https://lists.jboss.org/mailman/listinfo/aerogear-dev
>     <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

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.jboss.org/pipermail/aerogear-dev/attachments/20170814/edc6934b/attachment-0001.html 
-------------- next part --------------
A non-text attachment was scrubbed...
Name: Screenshot from 2017-08-11 11-20-41.png
Type: image/png
Size: 100204 bytes
Desc: not available
Url : http://lists.jboss.org/pipermail/aerogear-dev/attachments/20170814/edc6934b/attachment-0001.png 


More information about the aerogear-dev mailing list