Hi All, We have been long deferring proper documentation. We do not have a good place to put the API documentation too. How about we use some of the documentation sites like flossmanuals [1] or readthedocs[2].
Any opines on trying one of it or something similar for Airavata? For instance here is an example [3] on how cloudstack uses it. Suresh [1] - http://flossmanuals.net/ <http://flossmanuals.net/> [2] - https://readthedocs.org/ <https://readthedocs.org/> [3] - http://cloudstack-release-notes.readthedocs.org/en/4.5/ <http://cloudstack-release-notes.readthedocs.org/en/4.5/> > On Nov 4, 2013, at 2:09 PM, Suresh Marru <[email protected] > <mailto:[email protected]>> wrote: > > Any volunteers to revisit the release specific documentation? > > Before 1.0 one of our task is to come up with a process for bundling release > documentation and also host it on the WIKI. We should keep in mind the > semantic versioning we discussed earlier [1]. > > Suresh > [1] - http://markmail.org/thread/d6mx5sk553fkdi43 > <http://markmail.org/thread/d6mx5sk553fkdi43> > > > On Thu, Feb 16, 2012 at 4:34 PM, Heshan Suriyaarachchi > <[email protected] <mailto:[email protected]>> > wrote: > Hi Devs, > > Currently we don't have any documentation that is release specific. What we > do is update the documents(site) as we move on. As an example say that we > do 3 releases ie. 0.2, 0.3, 0.4. So, after doing the 0.2 release we will > update the site documentation with the documentation updates/improvements > for the release 0.3. So, down the line, if a user wants to use the release > 0.2, he might not be able to find the docs that he needs to run that > specific release. Therefore, as we add new features or modify the existing > features, there wont be any way for a user to keep track of what documents > to use with which release. > > So, how about we have the documentation also integrated to the build? Then > the documentation pack will also be built when the build is triggered, > which users can refer to. WDYT? > > -- > Regards, > Heshan Suriyaarachchi > > http://heshans.blogspot.com/ <http://heshans.blogspot.com/> >
