Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. First, you need to login as an Administrative user and visit the homepage of the latest Documentation (e.g. DSDOC17)
  2. Under the "Tools" side-menu, select the "Copy into New Space" option (should be at the bottom)
  3. Select a new Space Name and Space Key (ID) for this brand new space. Make sure to follow our recommended Space ID naming conventions as described above.
    • Space Name Format: "DSpace #.x Documentation" (e.g. "DSpace 3.x Documentation")
    • Space Key (ID) format: "DSDOC#x" (e.g. DSDOC3x for 3.x Documentation)
  4. Once the new Space has been generated, visit the new Space. You'll need to change the main page name to match the new version number (e.g. "DSpace 3.x Documentation").
  5. Next you'll need to tweak several Space settings to get it formatted similar to the rest of our Documentation. We'll start simple by tweaking the "Space Description"
    • Go to "Browse -> Space Admin" and change the "Space Description" to have the correct version number (e.g. "Official docs for DSpace 3.x") and click "Save".
  6. Now, change the "Documentation Space Header" so that we have the "Unreleased Documentation Header" in place. The full instructions can be found below in the #Documentation Space Headers section.
  7. Now, change the Left Sidebar to load up the _DocLeftSidebar shared content (this displays the DSpace logo and list of recent versions). The full instructions can be found below in the #Documentation Shared Sidebar section.
  8. Modify the All Documentation wiki page to list this version of the Documentation, and make sure to note that it is UNRELEASED.
  9. Finally, let's check/update the Space permissions / access rights
    • Go to "Browse -> Space Admin" and click on "Permissions"
    • On the Permissions page, assign these permissions to these groups:
      • 'confluence-users' group -> "View" and "Add Comments" permissions only
      • 'dspace-committer' group -> Full permissions (select all options, including Admin)
      • 'dspace-docgardener' group -> Full permissions (select all options, including Admin)

...