[
https://jira.duraspace.org/browse/DS-1036?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=22528#comment-22528
]
Tim Donohue commented on DS-1036:
---------------------------------
+1 for removing HTML Docs from Source Code (as an online version is now
available on the Wiki)
+1 for *keeping* PDF Docs in the Source Code (so that we have one 'offline'
copy of formal documentation still distributed with DSpace code.)
+1 to also moving the contents of 'postgres-upgrade-notes.txt' to our formal
documentation on the Wiki (if there is worthwhile content there).
I also welcome any README changes others would recommend. The only files we
must obviously keep are the LICENSE and NOTICE files (which detail our current
DSpace Code Licenses & License history). Beyond that, anything else can be
changed/modified as we see fit.
> Cleanup Documentation and README files (Maintaining HTML Docs in SVN creates
> "merge noise" for enduser developers.)
> -------------------------------------------------------------------------------------------------------------------
>
> Key: DS-1036
> URL: https://jira.duraspace.org/browse/DS-1036
> Project: DSpace
> Issue Type: Task
> Affects Versions: 1.7.2, 1.8.0
> Reporter: Mark Diggory
> Fix For: 1.8.0
>
>
> I recommend we drop storing html versions of the documents in the SVN.
> Having these here creates merge noise when they are regenerated across
> versions. Using the PDF seems sane.
> Likewise, I recommend that the following file contents be consolidated into
> the documentation and removed from Source.
> http://scm.dspace.org/svn/repo/dspace/trunk/dspace/docs/postgres-upgrade-notes.txt
> Possibly recommend getting rid of some of the "docs" directory structure and
> instead put one PDF copy of Documentation at top level of project.
> Other recommendations for consolidating READMEs and Documentation Welcome....
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:
https://jira.duraspace.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
------------------------------------------------------------------------------
All the data continuously generated in your IT infrastructure contains a
definitive record of customers, application performance, security
threats, fraudulent activity and more. Splunk takes this data and makes
sense of it. Business sense. IT sense. Common sense.
http://p.sf.net/sfu/splunk-d2dcopy1
_______________________________________________
Dspace-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/dspace-devel
