Versions Compared

Old Version 163

changes.mady.by.user Hardy Pottinger

Saved on

compared with

New Version 164

changes.mady.by.user Tim Donohue

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Replace SF instructions with GitHub ones

...

Info
titleHow to Generate PDF Documentation

See this DSpace documentation management guide: How To Export Downloadable Docs from Wiki

Upload to SourceForge

Upload both the source and binary releases to Sourceforge.net. You can either upload them via the web interface, or copy them over via scp or other command line tools. If you want to copy the files from command line, follow the directions found here: http://apps.sourceforge.net/trac/sourceforge/wiki/File%20management%20service.  You should expect a few minutes' delay before the individual files become visible on SourceForge.

Using scp to copy to the "DSpace Stable" file directory: (example for 3.0 final)
(NOTE: You will need to first create the 'DSpace Stable/3.0' directory via SourceForge's Admin UI)

Code Block
scp <files> <username>,dspace@frs.sourceforge.net:"/home/frs/project/d/ds/dspace/DSpace\\ Stable/3.0/"
scp <documentation_pdf> <username>,dspace@frs.sourceforge.net:"/home/frs/project/d/ds/dspace/DSpace\\ Stable/3.0/DSpace-Manual.pdf"

Using scp  -r to copy to the "DSpace Release Candidate" file directory: (example for 3.0-rc1)
(NOTE: You will need to first create a folder in your target directory, named "3.0-rc1" or whatever the name of the release is, and then mv all the tar.gz and zip files to that folder... you're going to recursively scp the entire contents of that folder to Sourceforge)

Code Block
scp -r <release_folder_with_zips> <username>,dspace@frs.sourceforge.net:"/home/frs/project/d/ds/dspace/DSpace\\ Release\\ Candidate/"
scp <documentation_pdf> <username>,dspace@frs.sourceforge.net:"/home/frs/project/d/ds/dspace/DSpace\\ Release\\ Candidate/DSpace-Manual.pdf"

Update "latest release" on SourceForge

...

Create a new GitHub release & upload distribution files

  • From the GitHub UI, visit: https://github.com/DSpace/DSpace/tags
  • Find the newly tagged release & click on "Add Release Notes"
  • Add in some basic release notes (refer to prior versions for some standard text).  Please be sure to provide the following information:
    • A link to the Wiki Release Notes (in the DSDOC area)
    • A link to the general documentation for this release (again in the DSDOC area)
  • Upload the distribution files and a PDF export of the documentation. There should be 5 total files attached:
    • dspace-[version]-release.tar.gz
    • dspace-[version]-release.zip
    • dspace-[version]-src-release.tar.gz
    • dspace-[version]-src-release.zip
    • DSpace-Manual.pdf
  • When you are satisfied, publish the new release!

Update demo.dspace.org

See the procedure .

...