<html><head>
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
</head><body bgcolor="#FFFFFF" text="#000000">Would we be able to take
documentation written in Git with Asciidoc and dynamically place that
into other UI outputs? Two reasons of why this might be useful:<br>
<br>
- Bring documentation into the Hawkular community website to describe
certain capabilties<br>
- Bring documentation into the web console as context sensitive help
pop-ups/sidebars<br>
<br>
My current understanding of Asciidoc tells me this would be possible -
but wanted to ask!<br>
<br>
- Catherine<br>
<br>
<br>
<blockquote style="border: 0px none;"
cite="mid:3F689D66-6FA5-4346-ACAA-526ADA787AD5@redhat.com" type="cite">
<div style="margin:30px 25px 10px 25px;" class="__pbConvHr"><div
style="display:table;width:100%;border-top:1px solid
#EDEEF0;padding-top:5px"> <div
style="display:table-cell;vertical-align:middle;padding-right:6px;"><img
photoaddress="hrupp@redhat.com" photoname="Heiko W.Rupp"
src="cid:part1.01000706.02060202@redhat.com"
name="compose-unknown-contact.jpg" height="25px" width="25px"></div> <div
style="display:table-cell;white-space:nowrap;vertical-align:middle;width:100%">
<a moz-do-not-send="true" href="mailto:hrupp@redhat.com"
style="color:#737F92
!important;padding-right:6px;font-weight:bold;text-decoration:none
!important;">Heiko W.Rupp</a></div> <div
style="display:table-cell;white-space:nowrap;vertical-align:middle;">
<font color="#9FA2A5"><span style="padding-left:6px">February 19, 2015
at 4:51 AM</span></font></div></div></div>
<div style="color:#888888;margin-left:24px;margin-right:24px;"
__pbrmquotes="true" class="__pbConvBody"><div>Hey,<br><br>please add
yourself to the Doodle at <a class="moz-txt-link-freetext" href="http://doodle.com/a8ctk6wgwi3nh9f8">http://doodle.com/a8ctk6wgwi3nh9f8</a> <br>I will
close that tomorrow SOB<br><br> Heiko<br><br><br></div><div><!----><br></div></div>
<div style="margin:30px 25px 10px 25px;" class="__pbConvHr"><div
style="display:table;width:100%;border-top:1px solid
#EDEEF0;padding-top:5px"> <div
style="display:table-cell;vertical-align:middle;padding-right:6px;"><img
photoaddress="hrupp@redhat.com" photoname="Heiko W.Rupp"
src="cid:part1.01000706.02060202@redhat.com"
name="compose-unknown-contact.jpg" height="25px" width="25px"></div> <div
style="display:table-cell;white-space:nowrap;vertical-align:middle;width:100%">
<a moz-do-not-send="true" href="mailto:hrupp@redhat.com"
style="color:#737F92
!important;padding-right:6px;font-weight:bold;text-decoration:none
!important;">Heiko W.Rupp</a></div> <div
style="display:table-cell;white-space:nowrap;vertical-align:middle;">
<font color="#9FA2A5"><span style="padding-left:6px">February 17, 2015
at 9:15 AM</span></font></div></div></div>
<div style="color:#888888;margin-left:24px;margin-right:24px;"
__pbrmquotes="true" class="__pbConvBody"><div>Hey,<br><br>as we made
some progress with hawkular.github.io, the question came up what should
go there and if we can't just use something else instead.<br><br>I am
very much in favor of using AsciiDoc + git for the documentation -- user
and developer<br><br>Clear advantages that I see for this solution:<br><br>-
versioning is easy as it is built into git. We can easily create
branches for various versions of the Hawkular<br>without the complicated
clone process that we had in the past<br>- offline possibility an
author does not need to be online to write docs<br>- AsciiDoc is plain
text. The pages may have a handful of specific header lines, but if you
don't want to format any markup, then just don't<br>- Contributing is
easy. People just git clone the repo, make their changes and submit a
pull-request<br>- docs are directly rendered on GitHub<br>- AsciiDoc is
already used in our README.adoc files<br>- With AsciiDoctor there is a
good tool chain for creating good print, html, pdf, docbook output<br>-
it is possible to write docs in vi/emacs/Notepad<br><br>Tooling may not
yet be that perfect; the mvn jbake:inline mode is already quite well
able to re-create <br>the website locally though; with a browser
extension like "live-reload", editing a text is as wysiwyg as on a wiki<br><br><br>There
are other JBoss projects that follow the AsciiDoc+git approach with
great success<br>like <a class="moz-txt-link-freetext" href="http://arquillian.org">http://arquillian.org</a>, <a class="moz-txt-link-freetext" href="http://hibernate.org">http://hibernate.org</a>,
<a class="moz-txt-link-freetext" href="http://liveoak.io">http://liveoak.io</a>, <a class="moz-txt-link-freetext" href="http://torquebox.org(*)">http://torquebox.org(*)</a><br><br>Anyway I've started a
doodle to get feedback and then proceed further - so please visit<br><a class="moz-txt-link-freetext" href="http://doodle.com/a8ctk6wgwi3nh9f8">http://doodle.com/a8ctk6wgwi3nh9f8</a><br>so
that we can come to a documentation solution that we all use.<br><br>
Heiko<br><br>*) Actually uses Markdown as markup language<br><br><br><br>_______________________________________________<br>hawkular-dev
mailing list<br><a class="moz-txt-link-abbreviated" href="mailto:hawkular-dev@lists.jboss.org">hawkular-dev@lists.jboss.org</a><br><a class="moz-txt-link-freetext" href="https://lists.jboss.org/mailman/listinfo/hawkular-dev">https://lists.jboss.org/mailman/listinfo/hawkular-dev</a><br></div></div>
</blockquote>
<br>
<div class="moz-signature">-- <br>Catherine Robson<br>
User Experience Design<br>
Red Hat JBoss Middleware<br>
c: 978-944-3825<br>
<br>
</div>
</body></html>