On 10/4/2010 6:59 PM, Jeffrey Trimble wrote: > I may be hashing it over, but simply put, we are agreeing that: > > 1. The wiki will be the most current. And during the release cycle, > we'll edit there and then generate > a hard copy (PDF and statiic HTML).
Correct. > 2. That static copies could be linked from the wki/confluence > documentation for historical needs > and/or for those working with those previous releases. Correct -- in fact, they already are linked in upper right of the wiki documentation splash page. We can just continue this policy going forward. https://wiki.duraspace.org/display/DSDOC/DSpace+Documentation > So, for example, Version 1.6x should be linked in the Confluence pages > to the PDF and a HTML > set. And when 1.7 is released, we generate the PDF and the HTML and then > link from the Confluence > page back to th 1.7. release, since in theory we are working towards > 1.7x or 1.8. Yes -- that's correct. It's worth mentioning that obviously we can work on new Documention in the regular area of the DSpace wiki as well (https://wiki.duraspace.org/display/DSPACE/). In fact, we may want to suggest that as a "best practice", and in order to keep the official documentation "clean", all unfinished or in-progress documentation should initially be built on the regular Wiki. Once it is "ready for release", it can then be moved into the official Wiki Documentation area. That may help us avoid having too much "unfinished" documentation appearing in the official area (which would just look bad and would clutter things up). In other words, Jeff we may want to establish some general policies about how to work with the wiki docs. As our official "Doc Guru", I think these should be approved or suggested by you, based on how you see this process working best. A very basic example could be: * Making a small/minor change -- we suggest editing directly in Primary Docs area * Building new docs around a new feature -- we suggest initially create these docs on DSpace wiki. Move them over to Primary Docs area once the new feature is ready to be released (i.e. once the feature has been added to trunk). > I think we already have a page to link FROM---the release history > page--now that isn't mostly > easily discovered. I know that! We can **also** create a "previous > version" link right up front. > > There needs to be a preface/splash page from which we can create a TOC > and all the links. > > Yes? Yes -- I think that is all correct. Obviously, this is a first stab at how we want to manage our Wiki Documentation, and it may change over time (based on what we find works or doesn't). - Tim ------------------------------------------------------------------------------ Beautiful is writing same markup. Internet Explorer 9 supports standards for HTML5, CSS3, SVG 1.1, ECMAScript5, and DOM L2 & L3. Spend less time writing and rewriting code and more time creating great experiences on the web. Be a part of the beta today. http://p.sf.net/sfu/beautyoftheweb _______________________________________________ Dspace-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/dspace-devel
