User Tools
development:applications:supportpage:userguides
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| development:applications:supportpage:userguides [2020/11/03 14:41] – 10.91.120.28 | development:applications:supportpage:userguides [2021/06/25 10:09] (current) – external edit 127.0.0.1 | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ====== IDMS Support Page - User Guides ====== | ||
| + | Author: Michelle | ||
| + | |||
| + | ===== User Guides - Background ===== | ||
| + | |||
| + | Customer facing user guides are created for each IDMS application. The aim of these user guides is to assist users when interacting with the IDMS platform to carry out work. | ||
| + | |||
| + | User guides are updated during each sprint in conjunction with each development ticket. These updates are then deployed to the Errigal Support Page during each release. | ||
| + | |||
| + | Note: as of IDMS 3.14 (Oct 2020) the deployment process has been automated via Jenkins. More detail on this process can be found here: [[userguidesanddocumentation: | ||
| + | |||
| + | More information on the Support Page can be found on the [[development: | ||
| + | |||
| + | ---- | ||
| + | |||
| + | |||
| + | ===== Manually Uploading A User Guide ===== | ||
| + | |||
| + | The steps involved with uploading a new user guide to the support page are as follows: | ||
| + | - Navigate to the Support Page Dashboard by selecting the Dashboard button from the header menu on the Support Page. | ||
| + | - Note: you must have admin privileges to do so, this is tied to the admin tole. There is an IDMS ticket to make this more configurable. | ||
| + | - Once on the dashboard, select **Manage Files** controller to upload the PDF user guide file. | ||
| + | - From here select **Add New File** and add the PDF file, naming it accordingly: | ||
| + | - Now that the file itself has been uploaded you must make sure there is a corresponding entry for the user guide in the Manage User Guides controller. | ||
| + | - Select the **Manage User Guides** Controller. | ||
| + | - If a user guide entry already exists e.g. Ticketer Admin User Guide, select the user guide entry, select update and select the PDF file you just uploaded as the new version of that user guide. | ||
| + | - To create a new User Guide entry, select **new UserGuide** and enter a suitable name for the user guide before selecting the PDF file you uploaded for that user guide. | ||
| + | - Verify the changes have been successful by reviewing the user guides on the front end. | ||
| + | |||
| + | Note: It's good practice to remove old and unused files from the Manage Files controller after a new batch of user guides have been loaded. Simply go into each file and select Delete to remove them. Any files that are associated with User Guides or Release Notes etc. will be linked and will not be allowed to be deleted. | ||
Page Tools
