/rts-helpdesk-client-quickstart

Online quickstart guide for RTS's current helpdesk application.

Primary LanguageRuby

RTS Helpdesk: Client Quickstart Guide

Client quickstart guide for RTS's current helpdesk application.

Running Locally

bundle exec jekyll serve

Markdown Style Guide

The following rules should be followed when creating new markdown documents.

  • Internal links should be formatted as follows:
    • Same Folder: [name-of-doc-without-extension]
    • Lower Level: /[folder]/[folder]/[name-of-doc-without-extension] (number of [folder] elements as necessary)
    • Higher Level: ../ticket/create (number of .. elements as necessary)
  • Do NOT include the trailing / on any internal links because it seems to break them when it is hosted on GitHub Pages
  • All screenshots should be cropped to 580x250px so that they are consistent
  • Ensure all examples of issues are not specific to a single system because users from any system will be using this guide (e.g. "Unable to import data" instead of "Unable to import an NROL report")
  • Avoid referring to deploying to production because some clients (e.g. NR will SSoWPS) handle the deployment to production so we don't want to have tickets left open while we wait for them to carry out the deployment that could be weeks/months.

Adding a Page

?????

Notes

Just some general notes.

  • Open markdown links in a new tab

    [link name](url_link){:target="_blank"}