[Hawkular-dev] Hawkular.org

[Thomas Heute]

On Tue, Jun 14, 2016 at 2:12 PM, Gary Brown <gbrown at 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 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
>
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.jboss.org/pipermail/hawkular-dev/attachments/20160614/43cff0da/attachment.html