- Created by Gail Steinhart, last modified by Pauline Ward on Nov 26, 2021
Welcome to the 2021 DSpace documentation sprint
The dates of the sprint will be November 15-28, 2021. During this fortnight, the writing teams, coordinated by DCAT, will work asynchronously (and in planned, optional co-working sessions) to produce DSpace 7 documentation for repository, community and collection Administrators and Submitters. This is NOT technical documentation and your experience with previous versions of DSpace is sufficient.
How to participate
- Check out topics in google spreadsheet and claim your writing task/s (WRITER column). Blank documents for each topic are set up and linked from the spreadsheet.
- Have your own documentation for the previous versions of DSpace that could be re-used for DSpace 7 user documentation? Please add a link to google spreadsheet (POSSIBLE SOURCES column).
- Haven't tried out DSpace 7 yet? Please spend some time looking at DSpace 7 demo.
- Questions? Join the DCAT email list or DCAT channel on DSpace slack.
- Pick a doc that is unwritten, and write a draft.
- Pick a doc that is in draft status, and review it, and if it is completed then change the status to complete.
- If you can see a topic that is missing, that should be covered, please add it as a new row at the bottom of the spreadsheet.
Writing suggestions
- If you're documenting features used by a particular DSpace role (i.e. administrator, user), make sure you are logged in to an appropriate account. An admin login is available on the "Notes" tab of the planning spreadsheet, you may create your own regular user account in the demo instance.
- Suggested template
- Sample documentation
Reporting issues
- Trying to document something that does not seem to be working? Report a bug/issue:
Try out DSpace 7#ReportingIssues
Resources
- Try out DSpace 7 here: DSpace 7 demo
- Login using the details on the Demo homepage, either "Demo Collection Administrator" or "Submitter", or in some rare cases "Demo Community Administrator", depending on which functionality you are going to be documenting. Beware, during recent testing, the demo collection administrator role cannot submit an item, and the submitter role and community admin role cannot review any items using the workflow. So you might have to login with one set of details to create a collection, and then login with the other set of details so you can submit, and then login with the first set again to review the submission. You might find it useful to use incognito mode , or different browsers so you don't have to logout for these different operations.
- DSpace 7 information (selected):
- DSpace 7 technical documentation
- DSpace 7 release status (incl. links to release notes, some of which link to video demos)
Optional co-working sessions
Log in, explore DSpace 7, and work on documentation with peers! No need to commit for the whole length of a session, you may come and go as you please, as well as work asynchronously, at your convenience.
Register or contact the host for log in information for the session(s) you are interested in.
| Date | Time (UTC/host's local time zone) | Registration / host (contact host if no registration link) |
|---|---|---|
| Mon, 15 Nov | 16:00-18:00 MST (UTC-7) | Zoom meeting | Host: Kimberly Chapman, University of Arizona Libraries. Please message Kimberly for the meeting passcode. |
| Thurs, 18 Nov | 9:00-11:00 MST (UTC-7) | Zoom meeting | Host: Kimberly Chapman, University of Arizona Libraries. Please message Kimberly for the meeting passcode. |
| Tues, 23 Nov | 12:00-14:00 MST (UTC-7) | Zoom meeting | Host: Kimberly Chapman, University of Arizona Libraries. Please message Kimberly for the meeting passcode. |
NEW DATE Friday, 26 Nov | NEW DATE 14:00-17:00 GMT (London, Lisbon, Dublin) | NEW DATE Friday, 26 Nov. Apologies for any inconvenience. Please message Pauline Ward for the meeting details. |
| Thurs, 25 Nov | 9:00 - 10:00 GMT/UTC | Zoom meeting registration link. After registering, you will receive a confirmation email containing information about joining the meeting. | Iryna Kuchma, EIFL |
Previous 2021 sprint
One previous documentation sprint was carried out in January 2021. The bug reporting process was a wiki page Documentation sprint bug report . Whereas for the Nov 2021 sprint we're using the general DSpace 7 bug reporting approach as set out at Try out DSpace 7#ReportingIssues https://wiki.lyrasis.org/display/DSPACE/Try+out+DSpace+7#TryoutDSpace7-ReportingIssues
- No labels
1 Comment
Pauline Ward
I got one complete new document done, the request-a-copy as agreed. For the record, that was v clunky, adding a whole new issue. For any future documentation sprints, I'd say it'd be much more efficient if we work primarily in a live wiki from the outset, so we're not having to spend time creating things that will have to be moved into a wiki anyway in the end event. Everything is a work-in-progress in a wiki.