<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Tue, Jun 14, 2016 at 2:46 PM, Gary Brown <span dir="ltr"><<a href="mailto:gbrown@redhat.com" target="_blank">gbrown@redhat.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">How will the common content between the Hawkular Server and Hawkular Metrics user guides be managed?<br></blockquote><div><br></div><div>If we could use the same source and build the 2 docs, that would be optimal IMO. Not sure if that's doable.</div><div>My priority is really hawkular-services and that the services makes sense together so the Hawkular Metrics doc could also just link to a specific chapter of Hawkular services.</div><div><br></div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Although not related to structure - if we do continue to use gitbook for docs, I assume there will actually be a separate doc then for the installation and user guide - so in terms of the APM gitbook I will need to move the installation and API sections out?<br>
<br>
If so, could you create the repo for the APM installation guide, and also an agent guide.<br></blockquote><div><br></div><div>We're not there yet, but possibly. We can also link to a chapter of the guide, at least temporarily.</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div class="HOEnZb"><div class="h5"><br>
Regards<br>
Gary<br>
<br>
----- Original Message -----<br>
><br>
> On Tue, Jun 14, 2016 at 2:12 PM, Gary Brown < <a href="mailto:gbrown@redhat.com">gbrown@redhat.com</a> > wrote:<br>
><br>
><br>
> Hi<br>
><br>
> Currently only have one observation - under User Guide it has Hawkular Server<br>
> and Hawkular Metrics - however I believe Metrics is part of Hawkular Server.<br>
><br>
> is *also* part of Hawkular server, yes.<br>
><br>
><br>
><br>
> So should the User Guide be broken down into functional areas, rather than be<br>
> based on packaging, as I guess that its usage will be the same (mostly)<br>
> whether standalone or packaged? And where differences occur, then the guide<br>
> can highlight the differences?<br>
><br>
> Yes that the dilemma. As a user I think I would prefer based on packaging as<br>
> I want to have the documentation for what I am running, today there is a<br>
> split per functional area (actually it's per "component"), it makes it<br>
> harder to grasp what one can do and how, plus it's missing the link between<br>
> the components, as how to use them together.<br>
><br>
><br>
> Thomas.<br>
><br>
><br>
> If this change is appropriate, then it might be possible for some/all of the<br>
> 'clients' to be described under the functionality area they are related to.<br>
><br>
><br>
><br>
><br>
><br>
> Regards<br>
> Gary<br>
><br>
> ----- Original Message -----<br>
> > With the recent repackaging effort + the ManageIQ UI, we need to rethink<br>
> > <a href="http://hawkular.org" rel="noreferrer" target="_blank">hawkular.org</a> .<br>
> ><br>
> > It's tricky to keep it simple, what to download, for what usecase... And at<br>
> > the moment it's getting outdated.<br>
> ><br>
> > IMO, it should be trivial for end users to figure out:<br>
> > - What to download<br>
> > - where to download and how to install the server<br>
> > - find/browse/download the various options to feed the server with data (WF<br>
> > agent, ptrans supported protocoles, ...)<br>
> > - find/browse/download options to use/read the data: (ManageIQ, Grafana...)<br>
> ><br>
> > and for the developers<br>
> > - find/browse/download the client libraries (Ruby, Python...)<br>
> > - Find client libraries documentation<br>
> > - Find examples...<br>
> ><br>
> > We should probably not separate/fork Hawkular Services from Hawkular<br>
> > "community" too much, beside the installation procedure and few things that<br>
> > we would mention as only available in the "larger" package. I use the term<br>
> > "Hawkular Server" in the mind map for the 2 "flavors".<br>
> ><br>
> > Please propose improvements to the draft attached that represents the<br>
> > website<br>
> > structure. (A square is not necessarily a page, it may be a section of a<br>
> > page)<br>
> ><br>
> > Thomas<br>
> ><br>
> > _______________________________________________<br>
> > hawkular-dev mailing list<br>
> > <a href="mailto:hawkular-dev@lists.jboss.org">hawkular-dev@lists.jboss.org</a><br>
> > <a href="https://lists.jboss.org/mailman/listinfo/hawkular-dev" rel="noreferrer" target="_blank">https://lists.jboss.org/mailman/listinfo/hawkular-dev</a><br>
> ><br>
> _______________________________________________<br>
> hawkular-dev mailing list<br>
> <a href="mailto:hawkular-dev@lists.jboss.org">hawkular-dev@lists.jboss.org</a><br>
> <a href="https://lists.jboss.org/mailman/listinfo/hawkular-dev" rel="noreferrer" target="_blank">https://lists.jboss.org/mailman/listinfo/hawkular-dev</a><br>
><br>
><br>
><br>
><br>
> _______________________________________________<br>
> hawkular-dev mailing list<br>
> <a href="mailto:hawkular-dev@lists.jboss.org">hawkular-dev@lists.jboss.org</a><br>
> <a href="https://lists.jboss.org/mailman/listinfo/hawkular-dev" rel="noreferrer" target="_blank">https://lists.jboss.org/mailman/listinfo/hawkular-dev</a><br>
><br>
_______________________________________________<br>
hawkular-dev mailing list<br>
<a href="mailto:hawkular-dev@lists.jboss.org">hawkular-dev@lists.jboss.org</a><br>
<a href="https://lists.jboss.org/mailman/listinfo/hawkular-dev" rel="noreferrer" target="_blank">https://lists.jboss.org/mailman/listinfo/hawkular-dev</a><br>
<br>
<br>
</div></div></blockquote></div><br></div></div>