Using This Documentation
How the TEP documentation website is organized, how to search it, and what the different notices mean.
On this page
How the documentation is organized
The documentation is divided into sections that you can reach from the navigation bar at the top of every page:
| Section | What you'll find |
|---|---|
| Getting Started | The basics of TEP and of this website |
| Implementation Guides | Setting up TEP for an organization |
| Administrator Guides | Day-to-day administration tasks |
| User Guides | Guides for each user role |
| Program Guides | Information for each supported program |
| Integration Guides | Connecting TEP to other services |
| Reports and Dashboards | Reporting and exporting data |
| Troubleshooting and FAQ | Solutions to common problems |
Inside an article, use the navigation on the left to move between articles in the same section, and the On this page list to jump to a heading.
Searching the documentation
- Select the search box at the top of any page. You can also press the
/key. - Type one or more words, such as registration or password.
- Press Enter to see results.
- Optionally, narrow the results by choosing a category on the results page.
Tip
Short, specific words usually work better than full sentences.
Notices used in articles
Note
Notes give helpful background information.
Tip
Tips suggest an easier or faster way to do something.
Important
Important notices highlight information you should not miss.
Warning
Warnings describe actions that could cause problems or that cannot be undone.
Troubleshooting
Troubleshooting notices explain what to do when something doesn't work as expected.
Screenshots
Many articles include screenshots of TEP. Select a screenshot to view a larger version.
Printing and downloading
Every article has a Print button that produces a clean, printer-friendly version of the page. When a Word or PDF version of a guide is available, Download buttons appear next to it.