Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [kapua-dev] Project documentation

Ok many thanks Stefano!


On Tue, Dec 20, 2016, 19:21 Morson, Stefano <stefano.morson@xxxxxxxxxxxx> wrote:

Hi Henryk,


I think that we could use the GitHub Wiki. We recently added the SSO chapter regarding how to setup Kapua and the environment to work with OpenId identity providers.

We could also migrate under the wiki the Quick Start Guide that is still in a markdown file in kapua/dev-tools and we could add more as long as more functionalities are added to develop.


Later we would like also to release some user documentation. The initial idea for this use case was to write the user manual in the form of markdown files inside a on purpose folder like for example kapua/doc. 

This will allow to produce the documentation as part of the build by using an external tool capable of processing and publishing the markdown files. For example a tool like Jekyll produces a static html website.



Stefano 



From: kapua-dev-bounces@xxxxxxxxxxx <kapua-dev-bounces@xxxxxxxxxxx> on behalf of Henryk Konsek <hekonsek@xxxxxxxxx>
Sent: Monday, December 19, 2016 11:26:45 AM
To: kapua-dev@xxxxxxxxxxx
Subject: [kapua-dev] Project documentation
 
Hi,

Where do we keep project documentation? Have we settle an agreement regarding this?

Cheers!
--
Henryk Konsek
View Henryk Konsek’s professional profile on LinkedIn. LinkedIn is the world's largest business network, helping professionals like Henryk Konsek discover inside ...

_______________________________________________
kapua-dev mailing list
kapua-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/kapua-dev
--
Henryk Konsek

Back to the top