| User manuals/documentation [message #1777329] |
Tue, 28 November 2017 09:27  |
Eclipse User |
|
|
|
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 #1777763 is a reply to message #1777754] |
Mon, 04 December 2017 06:39  |
| Eclipse User |
|
|
|
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 #1778178 is a reply to message #1777856] |
Mon, 11 December 2017 08:45 |
| Eclipse User |
|
|
|
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.
|
|
|
Powered by
FUDForum. Page generated in 0.06606 seconds
Home