<div dir="ltr">I like the idea of a custom landing page, and using asciibinder thereafter for all docs.<div>The landing page would initially function as a gateway to the upstream docs, and any other upstream content (e.g. contributing guide)<br></div><div>Adding downstream or other version of docs could come later.</div><div><br></div><div>@Paul, @Laura What would be involved in converting the existing Aerogear docs into asciidoc and getting them working with asciibinder?<br></div><div>It would make sense to leave behind docs for anything deprecated or no longer maintained.<br></div><div><br></div><div>Updating any docs (e.g. UPS) could be a task for after the initial 'getting things working with asciibinder'.</div><div>Similarly, moving Sync docs could be a task after the initial work.</div><div><br></div></div><div class="gmail_extra"><br><div class="gmail_quote">On 19 December 2017 at 09:34, Wojciech Trocki <span dir="ltr"><<a href="mailto:wtrocki@redhat.com" target="_blank">wtrocki@redhat.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><div>+1 for kicking out some investigations. <br></div><div>Let me know if you need something specific. <br><div>I see that most of the JBoos products now using ascidocs based documentation. </div><div><br></div><div>For example:</div><div><a href="http://www.keycloak.org/docs/latest/getting_started/index.html" target="_blank">http://www.keycloak.org/docs/l<wbr>atest/getting_started/index.ht<wbr>ml</a><br></div><div><a href="https://docs.jboss.org/jbpm/release/7.4.1.Final/jbpm-docs/html_single" target="_blank">https://docs.jboss.org/jbpm/re<wbr>lease/7.4.1.Final/jbpm-docs/ht<wbr>ml_single</a><br></div><span class=""><div><br></div><div><br></div><div>> <span style="font-size:12.8px">However I'm not sure if this means revamping </span><a href="http://aerogear.org/" style="font-size:12.8px" target="_blank">aerogear.org</a><span style="font-size:12.8px"> or the introduction of a new site </span><a href="http://docs.aerogear.org/" style="font-size:12.8px" target="_blank">docs.aerogear.org</a><span style="font-size:12.8px"> ?</span></div><div><span style="font-size:12.8px"><br></span></div></span><div>Aerogear is project aggregator website so aproach will need to be different than when building webpage for single project.<span style="font-size:12.8px"><br></span></div><div><span style="font-size:12.8px">IMHO best is to refresh aerogear webpage layout to support project subpages. For example <br><br><a href="http://aerogear.org/sync" target="_blank">aerogear.org/sync</a> </span></div><div><span style="font-size:12.8px"><a href="http://aerogear.org/digger" target="_blank">aerogear.org/digger</a></span></div><div><span style="font-size:12.8px"><br>Example layout:</span></div><div><span style="font-size:12.8px"><br></span></div><div><span style="font-size:12.8px"><img src="cid:ii_1606e1c3db9a3822" alt="Inline image 1" width="562" height="405"><br></span></div><div><span style="font-size:12.8px">Then each of this subpages can have general information, links to documentation, supported versions etc.</span></div><div>This aproach is really common for open source projects aggregators.<br><br><br></div></div><div class="gmail_extra"><div class="gmail_quote"><div><div class="h5">On Mon, Dec 18, 2017 at 8:04 PM, Paul Wright <span dir="ltr"><<a href="mailto:pwright@redhat.com" target="_blank">pwright@redhat.com</a>></span> wrote:<br></div></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div><div class="h5">
<div bgcolor="#FFFFFF" text="#000000">
Hi Laura, All,<br>
I'd like to follow up about the suggestion of a new site, thinking
specifically about:<br>
* much of the existing content is out of date<br>
* there is a lot of 'formerly feedhenry) material to be published
next year (eg mcp, sync)<br>
* the rendering toolchain is sub-optimal (in my POV) <br>
* big changes are happening anyway (now is the opportunity)<br>
<br>
However I'm not sure if this means revamping <a href="http://aerogear.org" target="_blank">aerogear.org</a> or the
introduction of a new site <a href="http://docs.aerogear.org" target="_blank">docs.aerogear.org</a> ?<br>
So, let me propose this, which is what I'd like to see:<br>
<br>
* Versioned docs for each component <br>
* A doc set for combining a set of components into a release <br>
* An asciidoc-first approach to the docs (altho I'd like to see
markdown still supported for blogs/etc)<br>
<br>
With this in mind, I'm playing with asciibinder, for example, see
the digger docs [1], this has the advantage:<br>
<br>
* it's what OpenShift uses<br>
* it's geared towards complex doc sets<br>
* it's geared to multiple version doc sets<br>
* it's lightweight and gathering some momentum (eg fedora are now
using it)<br>
<br>
Maybe it's used for everything but the home page as per OS [2]<br>
<br>
Or maybe the existing <a href="http://aerogear.org" target="_blank">aerogear.org</a> lives on, and users only hit the
asciibinder html at a lower level?<br>
<br>
WDYT?<br>
<br>
thanks,<br>
Paul<br>
<br>
<br>
[1]
<a class="m_1035532613395363118m_8279313351430761476m_-3936158680188330491moz-txt-link-freetext" href="https://5-114535426-gh.circle-artifacts.com/0/home/circleci/docs/_preview/digger/latest/installation/digger-install-intro.html" target="_blank">https://5-114535426-gh.circle-<wbr>artifacts.com/0/home/circleci/<wbr>docs/_preview/digger/latest/in<wbr>stallation/digger-install-intr<wbr>o.html</a><br>
<br>
[2] <a class="m_1035532613395363118m_8279313351430761476m_-3936158680188330491moz-txt-link-freetext" href="https://docs.openshift.com/" target="_blank">https://docs.openshift.com/</a><br>
<br>
<pre>Date: Fri, 15 Dec 2017 13:56:57 +0000
From: Laura Fitzgerald <a class="m_1035532613395363118m_8279313351430761476m_-3936158680188330491moz-txt-link-rfc2396E" href="mailto:lfitzger@redhat.com" target="_blank"><lfitzger@redhat.com></a>
To: AeroGear Developer Mailing List <a class="m_1035532613395363118m_8279313351430761476m_-3936158680188330491moz-txt-link-rfc2396E" href="mailto:aerogear-dev@lists.jboss.org" target="_blank"><aerogear-dev@lists.jboss.org></a><wbr>,
<a class="m_1035532613395363118m_8279313351430761476m_-3936158680188330491moz-txt-link-abbreviated" href="mailto:feedhenry-dev@redhat.com" target="_blank">feedhenry-dev@redhat.com</a>
Subject: Re: [feedhenry-dev] Suggestion/Discussion - Removal of
AeroGear.org Production Branch
Message-ID:
<a class="m_1035532613395363118m_8279313351430761476m_-3936158680188330491moz-txt-link-rfc2396E" href="mailto:CA+jLkhW2g4rrLfptKKUnAN5=LnMLksErnjXHnVXWVr7Fw9xcnA@mail.gmail.com" target="_blank"><CA+jLkhW2g4rrLfptKKUnAN5=LnML<wbr>ksErnjXHnVXWVr7Fw9xcnA@mail.gm<wbr>ail.com></a>
Content-Type: text/plain; charset="utf-8"
Hi all,
I had sent this email re improving the way that we pubish <a href="http://aerogear.org" target="_blank">aerogear.org</a>.
Some may have seen it and replied but as there is some problems with
aerogear-dev mailing and there has been some further discussions I wanted
to reopen a conversation re Aerogear.org.
With the move to the aerogear org there has been some conversation aroung
an overhaul of the <a href="http://aerogear.org" target="_blank">aerogear.org</a> website.
It was also suggested that we could go with a brand new site rather than
rejigging the old site.
I'm thinking that it would be worth having a discussion around how we would
go about this.
If anyone has particular interest in this and/or experience with the old
site and existing tech and wants to open a proposal/discussion re tech
stack, design, content etc I think it would be suitable to to do that via
the proposals repo [1] or via some discussion here.
I've been involved in adding some content recently with the Aerogear Digger
Project and my vote would be for creating something new and shiny!!!
Wdy guys t?
[1] <a class="m_1035532613395363118m_8279313351430761476m_-3936158680188330491moz-txt-link-freetext" href="https://github.com/aerogear/proposals" target="_blank">https://github.com/aerogear/pr<wbr>oposals</a>
On Wed, Dec 6, 2017 at 11:07 AM, Laura Fitzgerald <a class="m_1035532613395363118m_8279313351430761476m_-3936158680188330491moz-txt-link-rfc2396E" href="mailto:lfitzger@redhat.com" target="_blank"><lfitzger@redhat.com></a>
wrote:
</pre>
<blockquote type="cite" style="color:#000000">
<pre>Hi all,
I have recently gone through the process of publishing documentation for
AeroGear Digger to <a href="http://aerogear.org" target="_blank">aerogear.org</a>.
The process for adding docs for digger was as follows:
- Make changes on Feature Branch over a period of time.
- At some point merge lots of commits (difficult to review) from Feature
Branch to master.
- This publishes to <a href="http://staging.aerogear.org" target="_blank">staging.aerogear.org</a> (build needs to be manually
triggered in Jenkins)
- At some point merge master (again with lots of commits) to production
branch
- This publishes to <a href="http://aerogear.org" target="_blank">aerogear.org</a> (build needs to be manually triggered)
Out of this we attempted to improve the process by adding development
steps to the README [1] outlining that
-> each change should be verified on it's own -> merged to master -> and
then merged to production
removing the wait time and merges which involved lots of commits and
changes.
*I think there are a few things we can do to make this better. (simpler)*
*1) How?*
Remove the production branch (and related steps) altogether.
*Why?*
- All this documentation is done in the open.
- All branches are visible to all users/developers.
- <a href="http://staging.aerogear.org" target="_blank">staging.aerogear.org</a> is not private so I don't see that we gain
something by having this step.
- Changes can be verified locally by building the website using the steps
in the README [2] before being merged to master.
*2) How?*
Automate the publishing of the site
*Why?*
Right now the building of the site has to be triggered manually via a
Jenkins instance on cloudbees. If we remove production and enforce that all
changes are fully verified before being merged to master then we can
automate that any new changes are published immediately once merged to
master.
*3) How?*
Add some sort of versioning to the documentation. This could be in the
form of tagging the repo once we have a release of a product.
*Why?*
If we are always publishing docs once a change is made to the product then
we should version the documentation so we know which version of the docs
matches older versions of the product.
~~~~~~~~~~~
I'm really interested in some feedback on this. Let me know what you
think. Is there a better/simpler way to do it than I suggested?
[1] <a class="m_1035532613395363118m_8279313351430761476m_-3936158680188330491moz-txt-link-freetext" href="https://github.com/aerogear/aerogear.org/blob/" target="_blank">https://github.com/aerogear/ae<wbr>rogear.org/blob/</a>
master/README.md#development-s<wbr>teps
[2] <a class="m_1035532613395363118m_8279313351430761476m_-3936158680188330491moz-txt-link-freetext" href="https://github.com/aerogear/aerogear.org/blob/" target="_blank">https://github.com/aerogear/ae<wbr>rogear.org/blob/</a>
master/README.md#building
--
LAURA FITZGERALD
Red Hat Mobile <a class="m_1035532613395363118m_8279313351430761476m_-3936158680188330491moz-txt-link-rfc2396E" href="https://www.redhat.com/" target="_blank"><https://www.redhat.com/></a>
Communications House, Cork Road
Waterford City, Ireland X91NY33
<a class="m_1035532613395363118m_8279313351430761476m_-3936158680188330491moz-txt-link-abbreviated" href="mailto:lfitzger@redhat.com" target="_blank">lfitzger@redhat.com</a> IM: lfitzgerald
<a class="m_1035532613395363118m_8279313351430761476m_-3936158680188330491moz-txt-link-rfc2396E" href="https://red.ht/sig" target="_blank"><https://red.ht/sig></a>
</pre>
</blockquote>
<pre></pre>
</div>
<br></div></div>______________________________<wbr>_________________<br>
feedhenry-dev mailing list<br>
<a href="mailto:feedhenry-dev@redhat.com" target="_blank">feedhenry-dev@redhat.com</a><br>
<a href="https://www.redhat.com/mailman/listinfo/feedhenry-dev" rel="noreferrer" target="_blank">https://www.redhat.com/mailman<wbr>/listinfo/feedhenry-dev</a><br>
<br></blockquote></div><span class="HOEnZb"><font color="#888888"><br><br clear="all"><div><br></div>-- <br><div class="m_1035532613395363118m_8279313351430761476gmail_signature" data-smartmail="gmail_signature"><div dir="ltr"><div><div dir="ltr"><div dir="ltr"><div dir="ltr"><div dir="ltr"><div dir="ltr"><div style="font-size:12.8px"><p style="color:rgb(0,0,0);font-family:overpass,sans-serif;font-weight:bold;margin:0px;padding:0px;font-size:14px;text-transform:uppercase"><span>WOJCIECH</span> <span>TROCKI</span></p><p style="font-family:overpass,sans-serif;margin:0px;font-size:10px;color:rgb(153,153,153)"><a href="https://www.redhat.com/" style="color:rgb(0,136,206);margin:0px;text-decoration:none" target="_blank">Red Hat <span>Mobile</span></a></p><p style="font-family:overpass,sans-serif;margin:0px 0px 6px;font-size:10px;color:rgb(153,153,153)"><span>IM: <span>wtrocki</span></span></p><table border="0" style="color:rgb(0,0,0);font-family:overpass,sans-serif;font-size:medium"><tbody><tr><td width="100px"><a href="https://red.ht/sig" target="_blank"><img src="https://www.redhat.com/files/brand/email/sig-redhat.png" width="90" height="auto"></a></td></tr></tbody></table></div></div></div></div></div></div></div></div></div>
</font></span></div></div>
<br>______________________________<wbr>_________________<br>
feedhenry-dev mailing list<br>
<a href="mailto:feedhenry-dev@redhat.com">feedhenry-dev@redhat.com</a><br>
<a href="https://www.redhat.com/mailman/listinfo/feedhenry-dev" rel="noreferrer" target="_blank">https://www.redhat.com/<wbr>mailman/listinfo/feedhenry-dev</a><br>
<br></blockquote></div><br><br clear="all"><div><br></div>-- <br><div class="gmail_signature" data-smartmail="gmail_signature"><div dir="ltr"><div><div dir="ltr">David Martin<div>Red Hat Mobile</div><div>Twitter: <span style="font-size:12.8px">@irldavem</span></div><div><span style="font-size:12.8px">IRC: @irldavem (feedhenry, mobile-internal)</span></div></div></div></div></div>
</div>