[Hawkular-dev] Any objections to using gitbooks?

Gary Brown gbrown at redhat.com
Thu Jun 9 10:34:28 EDT 2016


Would this work? https://hawkular.gitbooks.io/hawkular-apm-user-guide/content/

Then it just needs to be linked from the hawkular.org documentation menu?

Regards
Gary

----- Original Message -----
> Hi
> 
> Once I have a reason version, I was thinking about changing the link from the
> Documentation->Sub-projects->Application Performance Management to link to
> the content link:
> https://hawkular.gitbooks.io/hawkular-apm-user-guide/content/
> 
> The first part of the intro could then be able it being a component of the
> Hawkular project, and having a link back to the website?
> 
> Regards
> Gary
> 
> ----- Original Message -----
> > The main drawback I see is the lack of integration with hawkular.org , any
> > thoughts how we can overcome that issue ?
> > 
> > On Tue, Jun 7, 2016 at 5:36 PM, Gary Brown < gbrown at redhat.com > wrote:
> > 
> > 
> > Was fairly straightforward - I've just transferred BTM content with some
> > changes (related to rename) - so more work is required on the content, and
> > need to setup travis to install changes to REST docs, but:
> > 
> > 1) Content is automatically made available here:
> > https://hawkular.gitbooks.io/hawkular-apm-user-guide/content/
> > 
> > 2) Can also obtain PDF from this page:
> > https://www.gitbook.com/book/hawkular/hawkular-apm-user-guide/details
> > 
> > 3) Once github repo has been setup, and initial README.adoc SUMMARY.adoc
> > and
> > .gitignore have been created, can run:
> > 
> > npm install gitbook-cli -g
> > 
> > gitbook serve
> > 
> > and then see content on localhost:4000
> > 
> > Regards
> > Gary
> > 
> > 
> > ----- Original Message -----
> > > So Hawkular APM will give it a try...
> > > 
> > > The Git repo is here:
> > > https://github.com/hawkular/hawkular-apm-user-guide
> > > 
> > > And the published book will be here:
> > > https://www.gitbook.com/book/hawkular/hawkular-apm-user-guide/welcome
> > > 
> > > 
> > > PS: At least another project/product used it successfully it seems:
> > > Keycloak
> > > / Red Hat SSO
> > > 
> > > 
> > > 
> > > On Mon, Jun 6, 2016 at 10:36 AM, Thomas Heute < theute at redhat.com >
> > > wrote:
> > > 
> > > 
> > > 
> > > I mostly have concerns about having docs spread over multiple solutions.
> > > But
> > > if the plan is to move all to gitbook, it should be ok.
> > > 
> > > Also we should still use AsciiDoc (I see that gitbook supports AscissDoc
> > > and
> > > Markdown)
> > > 
> > > Thomas
> > > 
> > > On Mon, Jun 6, 2016 at 9:27 AM, Gary Brown < gbrown at redhat.com > wrote:
> > > 
> > > 
> > > Hi
> > > 
> > > Wondering if gitbooks was ever considered for the documentation? Seems
> > > ideal
> > > as we can version each book with the component(s) it relates to, and
> > > users
> > > can download a pdf version for use offline.
> > > 
> > > Was thinking about experimenting with it for the updated APM docs?
> > > 
> > > Any objections?
> > > 
> > > Regards
> > > Gary
> > > _______________________________________________
> > > hawkular-dev mailing list
> > > hawkular-dev at lists.jboss.org
> > > https://lists.jboss.org/mailman/listinfo/hawkular-dev
> > > 
> > > 
> > > 
> > > 
> > > 
> > > _______________________________________________
> > > hawkular-dev mailing list
> > > hawkular-dev at lists.jboss.org
> > > https://lists.jboss.org/mailman/listinfo/hawkular-dev
> > > 
> > _______________________________________________
> > hawkular-dev mailing list
> > hawkular-dev at lists.jboss.org
> > https://lists.jboss.org/mailman/listinfo/hawkular-dev
> > 
> > 
> > 
> > 
> > _______________________________________________
> > hawkular-dev mailing list
> > hawkular-dev at lists.jboss.org
> > https://lists.jboss.org/mailman/listinfo/hawkular-dev
> > 
> _______________________________________________
> hawkular-dev mailing list
> hawkular-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/hawkular-dev
> 


More information about the hawkular-dev mailing list