Uploaded image for project: 'DSpace'
  1. DSpace
  2. DS-1036

Cleanup Documentation and README files (Maintaining HTML Docs in SVN creates "merge noise" for enduser developers.)

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Closed (View Workflow)
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 1.7.2, 1.8.0
    • Fix Version/s: 1.8.0
    • Component/s: None
    • Labels:
      None
    • Attachments:
      0
    • Comments:
      5
    • Documentation Status:
      Needed

      Description

      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....

        Attachments

          Activity

            People

            Assignee:
            robintaylor Robin Taylor
            Reporter:
            mdiggory Mark Diggory
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Dates

              Due:
              Created:
              Updated:
              Resolved: