Skip to main content


Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Eclipse Projects » Eclipse Kapua » User manuals/documentation
User manuals/documentation [message #1777329] Tue, 28 November 2017 14:27 Go to next message
Roger Hislop is currently offline Roger HislopFriend
Messages: 5
Registered: November 2017
Junior Member
Hi all - new to this forum. Just finished setting up Kapua, trying to get to grips with it.

I'm struggling with documentation ... on the Kapua project site it has some documentation, but it's basically just doc stubs (https://www.eclipse.org/kapua/docs/0.3.0/developer-guide/en/). There is info how to install, etc, but little or nothing on how to use, functional specs, the Web console...

Am I missing the obvious somewhere?
Re: User manuals/documentation [message #1777751 is a reply to message #1777329] Mon, 04 December 2017 09:06 Go to previous messageGo to next message
Roger Hislop is currently offline Roger HislopFriend
Messages: 5
Registered: November 2017
Junior Member
Anything? Anything?

A functional spec, even? 2,600 views, and no-one knows of documentation, whether draft or complete... seems incredible.

Re: User manuals/documentation [message #1777754 is a reply to message #1777751] Mon, 04 December 2017 10:01 Go to previous messageGo to next message
Milan Ggg is currently offline Milan GggFriend
Messages: 28
Registered: March 2017
Junior Member
Hello Roger.

Only thing that I can suggest you beside that documentation that you take a look to kapua API on http://localhost:8081/doc

Regards,
Milan
Re: User manuals/documentation [message #1777763 is a reply to message #1777754] Mon, 04 December 2017 11:39 Go to previous messageGo to next message
Roger Hislop is currently offline Roger HislopFriend
Messages: 5
Registered: November 2017
Junior Member
Hi Milan, Thanks for the reply.

I've started working through the API, but it seems (like most Open Source projects), the only documentation is the API docs, written by and for the people that are working on the project.

As someone coming from the outside, and wanting to implement an IOT hub in an actual working project, only having API docs is not hugely helpful ...

I need to make a call whether Kapua would be a useful system (and hence allocate budget and throw some devs into it), or whether I should just buy a commercial off the shelf product like Relayr, Yodiwo or Davra.

Surely SOMEWHERE in the initial design phases of the project, someone would have put together:

* system block diagram
* architecture outline
* functional spec

It just seems really arse-about-face trying to understand exactly what Kapua does by having to reverse engineer the API doc.

Re: User manuals/documentation [message #1777764 is a reply to message #1777763] Mon, 04 December 2017 11:55 Go to previous messageGo to next message
Milan Ggg is currently offline Milan GggFriend
Messages: 28
Registered: March 2017
Junior Member
Yes, I understand you.
Kapua is still in development phase, and there is a lot of job to do, bugs to fix, etc., but Kapua has potential to be good platform.
You can check on links below and see if there's some informations that you need.

https://dzone.com/articles/meet-kapua-an-open-source-end-to-end-iot-cloud-platform
https://dev.eclipse.org/mhonarc/lists/iot-wg/pdfhingByJRZj.pdf

Regars,
Milan
Re: User manuals/documentation [message #1777856 is a reply to message #1777764] Tue, 05 December 2017 11:51 Go to previous messageGo to next message
Roger Hislop is currently offline Roger HislopFriend
Messages: 5
Registered: November 2017
Junior Member
Cool, thanks. That PDF is useful... together with the overview on the project page (https://projects.eclipse.org/projects/iot.kapua) there is something to get on with.

Re: User manuals/documentation [message #1778178 is a reply to message #1777856] Mon, 11 December 2017 13:45 Go to previous message
Roger Hislop is currently offline Roger HislopFriend
Messages: 5
Registered: November 2017
Junior Member
I see from the mailing list that an initiative has been kicked off to improve documentation resources.

My team would be happy to assist in the documentation work, especially in terms of technical editing.

Previous Topic:POST data to kapua
Next Topic:Cannot get data from kapua
Goto Forum:
  


Current Time: Tue Nov 13 21:05:41 GMT 2018

Powered by FUDForum. Page generated in 0.26300 seconds
.:: Contact :: Home ::.

Powered by: FUDforum 3.0.2.
Copyright ©2001-2010 FUDforum Bulletin Board Software

Back to the top