Hi Lahiru, In addition to developer guide and user guide, it will be nice to have a higher level abstract documentation which describes Airavata components and architecture in a broad sense and largely is independent of a release. I think the current documentation is intended for that purpose, so are you proposing to enhance the current documentation for the higher level description and have a separate developer and user guides which are tied up to a release?
Hi All, Do we want to continue to have all documents on website itself or do we see a need for a Wiki as well? I think we should have a process of linking third party community written blogs and "how to's". Suresh On Sep 11, 2011, at 7:10 PM, Lahiru Gunathilake wrote: > Hi Raminder, > > On Fri, Sep 9, 2011 at 2:02 PM, Raminderjeet Singh <[email protected] >> wrote: > >> +1 for having a documentation area on a site is good and will be easy to >> manage. We can have documents folder in SVN also to manage the versions and >> can tag the documents for each release. Only thing which i have seen broken >> on other sites is the links to the document between the versions. Is anyone >> have experience with Maven site generation stuff? That way links and >> different versions can be handled better. >> > We can simply host the documentation pack in the site and point to the > latest release documentation for default documentation link and other we can > put with version name directory. > > Ex: default link: airavata.org/docs/index.html > airavata.org/docs/1.1.0/index.html > > And allow users to download a documentation zip file for each release while > hosting in the site. > > Lahiru > >> >> Thanks >> Raminder >> >> On Sep 9, 2011, at 11:26 AM, Lahiru Gunathilake wrote: >> >>> Hi Devs, >>> >>> Since we are getting closer to airavata release, we need to start >>> documentation process soon. I have number of things to write as Howto's >> Ex: >>> How to deploy ws-messenger on tomcat, how to deploy gfac services on >> tomcat >>> etc. >>> >>> How are we going to do the documentation ? Are we going to put them on >> to >>> our website and directly commit them to the site ? Or are we going to >>> release a documentation pack? >>> >>> How would the documentation structure looks like ? Where should someone >>> start the documentation ? >>> >>> Currently we have documentation tab in airavata website which is more of >> an >>> abstract documentation, I do not have a good feeling of putting the >> howto's >>> content in to that. I think we need to start documenting from how to use >>> airavata from the step of downloading the distribution and using it >>> standalone to deploy it in tomcat with mysql database etc. >>> >>> I personally like to have a developer Guide and a user guide hosted on >> the >>> website and put the content appropriately and keep all the documentation >>> online specific for each release. >>> >>> WDYT ? >>> >>> Regards >>> Lahiru >> >> > > > -- > System Analyst Programmer > PTI Lab > Indiana University
