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