[Hawkular-dev] Hawkular.org

Gary Brown gbrown at redhat.com
Wed Jun 15 07:12:39 EDT 2016


Its per book so would need to be copied:

header/footer html files: https://github.com/hawkular/hawkular-apm-user-guide/tree/master/layouts

referenced from: https://github.com/hawkular/hawkular-apm-user-guide/blob/master/book.json#L9-L10

Regards
Gary

----- Original Message -----
> But can it be applied to all books for an organization or does it need to be
> copied over all the books GItHub repos ?
> 
> On Wed, Jun 15, 2016 at 12:54 PM, Gary Brown < gbrown at redhat.com > wrote:
> 
> 
> Its possible to customise the header/footer html with the current gitbook
> version being used by APM:
> 
> header: http://pasteboard.co/1Hq9NDo9.png
> footer: http://pasteboard.co/1HqbdKdx.png
> 
> Just need a suitable html fragment/ banner image to be provided.
> 
> The header is same line as the search box, so needs to be constrained.
> 
> Regards
> Gary
> 
> ----- Original Message -----
> > 
> > 
> > On Wed, Jun 15, 2016 at 12:01 PM, Gary Brown < gbrown at redhat.com > wrote:
> > 
> > 
> > Hi
> > 
> > http://pasteboard.co/1HmIxzsJ.png
> > 
> > Tried using an iframe - problems are:
> > 
> > 1) Border around iframe - not sure if this can be reduced/removed
> > 
> > 2) When left hand menu showing, it is not possible to add comments (i.e. no
> > +
> > sign appears)
> > 
> > 3) When menu hidden, plus sign shows, but asks to sign in to comment - when
> > link selected the iframe content goes blank
> > 
> > So not sure iframe is a workable solution.
> > 
> > Will see what customisations can be made to the gitbook itself to look more
> > integrated - however wondering whether we should do much customisation, as
> > I
> > think users know they are navigating from a website to documentation, so
> > would not be concerned with a different look and feel - as long as a
> > consistent approach was used for all documentation.
> > 
> > Unless they arrive on the documentation from a Google search ;)
> > 
> > Thomas
> > 
> > 
> > 
> > Regards
> > Gary
> > 
> > ----- Original Message -----
> > > 
> > > 
> > > On Wed, Jun 15, 2016 at 10:17 AM, Heiko W.Rupp < hrupp at redhat.com >
> > > wrote:
> > > 
> > > 
> > > On 14 Jun 2016, at 22:32, Stefan Negrea wrote:
> > > 
> > > > I do not see the idea proposed yet, but why not structure the website
> > > > around major projects? We have Hawkular community, Hawkular Services,
> > > > Hawkular Metrics, and APM. Projects like Inventory or the clients
> > > > would
> > > > fall under Hawkular Services umbrella. So rather than designing a
> > > > generic
> > > > structure with everything make individual sub-sites and then apply the
> > > > structure you proposed.
> > > 
> > > I think even if/when Hawkular-metrics gets its own section (which is
> > > well
> > > warranted as we create a metrics distribution), we need to make sure
> > > that
> > > it blends well into the Hawkular-services documentation. We can for sure
> > > use some include tags to accomplish this. I think Hawkular-services
> > > should now be the main/default focus area of hawkular.org (at least
> > > from the non-APM side)
> > > 
> > > +1
> > > 
> > > 
> > > 
> > > Likewise we should also be careful with external documentation like
> > > gitbook. I have seen some pretty good and comprehensive documentation
> > > there, so the idea behind is good. An issue is certainly that it is yet
> > > another
> > > place for stuff and dilutes the content on hawkular.org .
> > > Perhaps there is a way to include/iframe it, the experience could
> > > potentially
> > > be good, as some of the current (long) pages have issues with the
> > > navigation
> > > via the page-tree in the left part.
> > > On the other hand (and I think this was mentioned already) there may be
> > > a way to include content from hawkular.org into the gitbook, so that it
> > > exists in both forms, but from one source (-> consistency)
> > > 
> > > Agreed.
> > > Gary could you look into the options to "blend" gitbook.io content better
> > > into hawkular.org ?
> > > 
> > > Here is the reference point:
> > > http://www.hawkular.org/docs/components/btm/index.html
> > > Maybe iFraming
> > > https://hawkular.gitbooks.io/hawkular-apm-user-guide/content/
> > > would work...
> > > Maybe using a custom theme that adds our hawkular.org header/footer in
> > > gitbook.io would work (I didn't see how to apply a theme to all books
> > > though)...
> > > 
> > > I gave you admin rights if you need to poke around, but I didn't see
> > > anything
> > > there that would help us...
> > > 
> > > Thomas
> > > 
> > > 
> > > 
> > > 
> > > 
> > > 
> > > _______________________________________________
> > > 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
> 
> 
> 
> 
> _______________________________________________
> 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