[Hawkular-dev] Any objections to using gitbooks?

Gary Brown gbrown at redhat.com
Tue Jun 7 11:36:05 EDT 2016


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
> 


More information about the hawkular-dev mailing list