Tim Donohue commented on Improvement DS-1638
Hi Bram,

Great work! I love what you are doing to reorg the docs. A few minor things that are out-of-place / missing:

1. The "Preface" is now buried under "DSpace Reference". I think this still needs to be at the beginning (could be renamed though), since it's where we detail the overall release and acknowledge who was involved.

2. Similarly, the old "Introduction" is buried under "DSpace Reference". It could potentially stay there but may need renaming (perhaps "Overview"?)

3. One bigger point: we need to keep in mind that eventually we'll want to create a PDF from these Wiki Docs. In past releases, we always created the PDF from the "DSpace System Documentation" page which was a parent of all other pages (e.g. https://wiki.duraspace.org/display/DSDOC3x/DSpace+System+Documentation). However, with the reorg, the only root "parent" page is the https://wiki.duraspace.org/display/DSDOC4x/DSpace+4.x+Documentation homepage. The problem is that if we currently generate the PDF from that page, we'll end up with contents of that page also appearing in the PDF (even the "Recently Updated" box). So the PDF looks a big odd. As I see it, there are two options:
    (a) Either recreate a parent page which is essentially just a Table of Contents (like the old "DSpace System Documentation" page)
    (b) OR, we rework the homepage so that it actually could be included in the final PDF. We'd likely need to remove the "Recently Updated" section and do some other minor cleanup.

Hopefully #3 isn't too confusing. You can see what I mean simply by generating a PDF following the instructions at: https://wiki.duraspace.org/display/DSDOC/How+To+Export+Downloadable+Docs+from+Wiki#HowToExportDownloadableDocsfromWiki-HowtoGeneratePDFversionofDocumentation
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
------------------------------------------------------------------------------
October Webinars: Code for Performance
Free Intel webinars can help you accelerate application performance.
Explore tips for MPI, OpenMP, advanced profiling, and more. Get the most from 
the latest Intel processors and coprocessors. See abstracts and register >
http://pubads.g.doubleclick.net/gampad/clk?id=60134071&iu=/4140/ostg.clktrk
_______________________________________________
Dspace-devel mailing list
Dspace-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/dspace-devel

Reply via email to