I would suggest to define a doc module in each repo: - concepts/api/core - extensions - sandbox
Putting it into modules allows us also to maintain the documentation as code, since it is basically also strongly coupled to the code we release... This would allows us to define a common structure and naming scheme. Given that we can also easily move documentation from sandbox to the extensions, when module are released from the sandbox. The API/core part should be pretty stable, but should also include our documentation on use cases and requirements. The doc packages could be built as normal zip, tgz assembly modules and published to maven central as well, so we have also the documentation in a easy linkable format for all released versions. Additionally we can include them into the corresponding Apache release packages easily as well, or link/extract its contents for a site update when we publish a release... WDYT? J Anatole 2016-12-04 16:33 GMT+01:00 Oliver B. Fischer <[email protected]>: > Dear all, > > I would like to add some documentation. Therefore I would like to know > where will keep and maintain our documentation. > > WDYT? > > Oliver > > > -- > N Oliver B. Fischer > A Schönhauser Allee 64, 10437 Berlin, Deutschland/Germany > P +49 30 44793251 > M +49 178 7903538 > E [email protected] > S oliver.b.fischer > J [email protected] > X http://xing.to/obf > > -- *Anatole Tresch* PPMC Member Apache Tamaya JCP Star Spec Lead *Switzerland, Europe Zurich, GMT+1* *maketechsimple.wordpress.com <http://maketechsimple.wordpress.com/> * *Twitter: @atsticks, @tamayaconf*
