User Tools
Writing /app/www/public/data/meta/development/applications/supportpage/supplementaldocumentation.meta failed
development:applications:supportpage:supplementaldocumentation
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
| development:applications:supportpage:supplementaldocumentation [2020/09/03 12:53] – created mmcc | development:applications:supportpage:supplementaldocumentation [2021/06/25 10:09] (current) – external edit 127.0.0.1 | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ====== IDMS Support Page - Supplemental Documentation ====== | ||
| + | |||
| + | Author: Michelle | ||
| + | |||
| + | ===== Supplemental Documentation - Background ===== | ||
| + | |||
| + | The Supplemental Documentation section on the Support Page is used to store documents that fall outside of user guides and release notes. These include things like Cheat Sheets or other small documents that may have be requested as part of support tickets etc. | ||
| + | |||
| + | These documents are usually added to the Support Page in line with a release but can often be uploaded ad hoc also. | ||
| + | |||
| + | More information on the Support Page can be found on the [[development: | ||
| + | |||
| + | ---- | ||
| + | |||
| + | ===== Supplemental Documentation - Generation ===== | ||
| + | |||
| + | Supplemental documentation is generated in the same way that the User Guides are. | ||
| + | Please consult this page for more detail on that process: [[userguidesanddocumentation: | ||
| + | |||
| + | |||
| + | ---- | ||
| + | |||
| + | ===== Manually Uploading Supplemental Documentation ===== | ||
| + | The steps involved with manually uploading new supplemental documentation 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 the **Manage Files** controller to upload the PDF supplemental documentation 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 supplemental documentation in the Manage Supplemental Documentation controller. | ||
| + | - Select the **Manage Supplemental Documentation** Controller. | ||
| + | - If a supplemental documentation entry already exists, select the entry, select update and then select the PDF file you just uploaded as the new version of that supplemental documentation. | ||
| + | - To create a new Supplemental Documentation entry, select **New SupplementalDocumentation** and enter a suitable name for the document before selecting the PDF file you uploaded. | ||
| + | - Verify the changes have been successful by reviewing the supplemental documentation 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 documents have been loaded. Simply go into each entry 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
