I would not necessarily do so, because:
- we can exclude them from the build easily by just moving the document generation into a profile - adding up the documentation to a nice assembly is more difficult if things are outside of the module Other opinions ? 2014-11-27 22:40 GMT+01:00 Oliver B. Fischer <[email protected]>: > @Anatole May we should move all the docs to a separate module? So it would > be easier to include/exclude it from a build. > > Oliver > > Am 27.11.14 21:58, schrieb Anatole Tresch: > >> Dear all >> >> I would suggest to try to ramp up the discussions (and along with it >> implementations) in the following way: >> >> *1. Use Cases and Requirements* >> >> *2. Core Concepts* >> *2.1 Environment, Stage* >> *2.2 PropertyProvider, Configuration and composite design* >> *2.3 Change Listeners and Mutability* >> *2.4 Extension Points* >> *2.5 Additional Services (default provider implementations, combining and >> filtering providers)* >> >> *3. Advanced Concepts* >> >> *3.1 Multi-Environment-Support* >> *3.2 Configuration Providers* >> *3.3 Freezing, Serialization, Remoting* >> >> *4. Modules* >> *4.1 CDI/EE Integration* >> *4.2 Other Java EE Support* >> *4.3 JMX Management ?* >> *4.4 Default Java EE Configuration (EE ready solution working OOTB)* >> *4.3 ???* >> >> *5. Extensions* >> *5.1 Configuration Client/Server...?* >> *5.2 Configuration Server Setup UIs?* >> >> I propose to setup an asciidoc document for each part. That way we can >> compose a comprehensive design documentation easily step by step and also >> keep good focus on the aspects. As a starting I will try to update/split >> the existing document here (mirrored): >> >> https://github.com/apache/incubator-tamaya/blob/master/ >> api/src/main/asciidoc/JavaConfigSpecification.adoc >> >> Without bigger objections I will try to setup the document parts >> accordingly. >> >> Additionally I would propose to move them from >> *api/src/main/asciidoc * >> up to >> * api/doc/* >> >> So they are more easily accessible. >> >> Do you think this is a good way to start? >> >> Best, >> Anatole >> >> >> >> > -- > 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* Java Engineer & Architect, JSR Spec Lead Glärnischweg 10 CH - 8620 Wetzikon *Switzerland, Europe Zurich, GMT+1* *Twitter: @atsticks* *Blogs: **http://javaremarkables.blogspot.ch/ <http://javaremarkables.blogspot.ch/>* *Google: atsticksMobile +41-76 344 62 79*
