User Tools

Site Tools


Writing /app/www/public/data/meta/onboarding/introduction/errigal_user_guides.meta failed
onboarding:introduction:errigal_user_guides

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
onboarding:introduction:errigal_user_guides [2017/05/03 15:08] mmcconboarding:introduction:errigal_user_guides [2021/06/25 10:09] (current) – created - external edit 127.0.0.1
Line 1: Line 1:
 +====== Errigal Support Page ======
 +
 +Author: Michelle McCausland
 +
 +====== Introduction ======
 +
 +The Errigal support page was created to serve as a repository for the most up to date IDMS User Guides & Training Videos
 +
 +Errigal user guides are available for each IDMS application as well as each release's release notes and can be found on the relevant Support Pages. 
 +
 +Additionally, there are Errigal Training videos that show the user how to interact with the specific features of an application.
 +
 +Updates to the user guides are completed in line with Development Sprints and any updates to the user guides should be verified with Michelle as they are stored in a separate repository.
 +
 +====== Tracking Sheets ======
 +In order to manage the user guide & training video release process, 2 sheets have been created:
 +  - User Guide Update Tracker - [[https://docs.google.com/spreadsheets/d/1AFtHjIyrUI8AT5TGDkoHXs1bnMdTjTLt-ucztAry75c/edit#gid=1722405221|Link Here]]
 +  - IDMS Training Videos - [[https://docs.google.com/spreadsheets/d/1YAkrAlWUXU-coiH_Yki1ZdiDHyLMha5pLEQm7wk2KYc/edit#gid=0|Link Here]]
 +
 +====== Updating Content on the Support Page ======
 +
 +Navigate to for example: https://idmsqa.errigal.com/Support/content/admin
 +
 +  - The **uploadable file** controller allows you to upload new versions of documents.
 +  - The **user guide** controller allows you to add new user guides to the support page.
 +  - The **release notes** controller allows you to add new release notes to the support page.
 +  - The **contact detail** controller allows you to add or update contact information.
 +  - The **training video** controller allows you to add any training videos to the support page.
 +
 +====== Add a new user guide to the support page ======
 +
 +  - Navigate to the support page admin section /Support/content/admin
 +  - Click on the **uploadable file** controller
 +  - Click on **New UploadableFile** to upload a new user guide pdf
 +  - Give the Uploadable file a suitable name and author and click create to create the file
 +  - With the uploadable file created, it is necessary to associate it with a User Guide to display it on the front page
 +  - Click on the **UserGuide** controller
 +  - Click on **New UserGuide** to create a new user guide
 +  - Give the user guide a suitable name and from the Document dropdown, select the uploadable file entry.
 +  - Click **Create** to create the user guide.
 +  - Navigating to the front page, you should now be able to view the new user guide
 +
 +
 +====== Add new release notes to the support page ======
 +
 +   - Navigate to the support page admin section /Support/content/admin
 +   - Click on the **uploadable file** controller
 +   - Click on **New UploadableFile** to upload a new release note pdf
 +   - Give the Uploadable file a suitable name and author and click create to create the file
 +   - With the uploadable file created, it is necessary to associate it with a Release Note to display it on the front page
 +   - Click on the **ReleaseNotes** controller
 +   - Click on **New ReleaseNotes** to create a new Release note
 +   - Give the Release Note a suitable name and from the Document dropdown, select the uploadable file entry.
 +   - Click **Create** to create the Release Note.
 +   - Navigating to the front page, you should now be able to view the new Release Note!