Hi Danesh, Thanks for bringing this up! This is a huge improvement and IMO we should include the reference YAML file in the product distribution for user reference purposes. It's true that hosted documentation would take care of most of that story, but there can be situations where the user only has a terminal and the product zip file, where a reference text file would come in handy.
Just a minor query, what is the purpose of the generated secure-vault.yaml file? Regards, Chamila de Alwis Committer and PMC Member - Apache Stratos Senior Software Engineer | WSO2 Blog: https://medium.com/@chamilad On Thu, Aug 31, 2017 at 11:37 AM, Danesh Kuruppu <[email protected]> wrote: > Hi all, > > With new global configuration model discussed in mail thread[1], we are > generating configuration files(for documentation purposes) automatically at > compile time by reading annotations and default values in config bean > classes. And those configuration files are packed in features under > config-docs directory like below(e.g). > > ├── features >> └── org.wso2.carbon.kernel_5.2.0.SNAPSHOT >> * ├── config-docs* >> * └── wso2.carbon.yaml* >> └── plugins >> └── org.wso2.carbon.core-5.2.0.SNAPSHOT.jar >> > > > Since those configuration files are only for documentation purposes, We > are not shipping them with product distribution. Currently those > configuration files are inside feature jar files and in order to read > relevant configuration file, we need to extract the jar file. > > In order solve this issue, we thought of collecting configuration docs in > all features when packaging product distribution using maven plugin. Maven > plugin will go through all features inside p2-repo > directory(distribution/target/p2-repo/features directory) and copy > configuration docs in each feature to one location like below > (distribution/target/config-docs) > > ├── distribution > ├── target > > > * ├── config-docs ├── secure-vault.yaml > └── wso2.carbon.yaml* > └── wso2carbon-kernel-5.2.0-SNAPSHOT.zip > > So when generating product distribution, we automatically get all > configuration files used in the product. This will also help when creating > product document. > > Appreciate your input on this. > > 1. http://wso2-oxygen-tank.10903.n7.nabble.com/Carbon-C5- > Server-Configuration-Model-td144549.html > > Thanks > -- > > *Danesh Kuruppu* > Senior Software Engineer | WSO2 > > Email: [email protected] > Mobile: +94 (77) 1690552 <+94%2077%20169%200552> > Web: WSO2 Inc <https://wso2.com/signature> > > > _______________________________________________ > Architecture mailing list > [email protected] > https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture > >
_______________________________________________ Architecture mailing list [email protected] https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture
