Your proposal sounds great to me, Laura. I added more comments below. Laura Stewart wrote: ... > Here is what I propose: > > 1) Ask for feedback from the derby-dev community about the information > on the Derby Documentation page that describes how to setup your > environment, update the files, and submit patches. > http://db.apache.org/derby/manuals/dita.html ... > RECOMMENDATION: Start a derby-dev thread about the instructions and > guidelines for updating the Derby documentation files. > I volunteer to start this thread and implement the recommendations > from the community.
Your recommendation sounds good. The http://db.apache.org/derby/manuals/dita.html link you mention is part of the forrest-generated web site. The source for that particular file is at https://svn.apache.org/repos/asf/db/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml . Information on how to checkout and build the web site is at http://db.apache.org/derby/papers/derby_web.html . Web site instructions also need more and better information. For example, they need to explain that the files under http://db.apache.org/derby/docs are actually generated separately from the web site and the web site simply points to those files hopefully achieving an integrated experience for the end user. > 2) Ask for feedback from the derby-dev community about the > documentation review process. > http://wiki.apache.org/db-derby/TenTwoDocReview ... > RECOMMENDATION: Start a derby-dev thread about the documentation review > process. > I'll volunteer to drive this discussion unless somebody else would > like to -- just let me know if you do :-) Again, your recommendation sounds good. Thanks for all your efforts on the docs. -jean
