Other sources of documentation¶
This page lists some other sources of documentation outside of the guidebook.
The guidebook is intended to be the repository for all documentation surrounding workflow, best practice and common technical standards. We may also add specific "application notes" on technologies or techniques within the notes section.
It is not intended for deep operational documentation on individual services. Generally that documentation is maintained by the individual service teams and is found in other locations.
Service specific documentation¶
Some services or groups of services have documentation located in specific places. This section provides links to those places. The majority of these links will only be accessible to members of DevOps.
"Former Dev Group Services"¶
We have inherited some services which were developed and maintained by a previous development group in UIS. They are:
- Lookup
- The Raven Password Application
- The Training Booking System
- The Human Tissue Tracker
- Eduroam tokens
- The Streaming Media Service
Other inherited services are in the process of being decommissioned or replaced.
We have not yet developed a per-service operational documentation strategy. For the moment, operational documentation exists in the following areas:
- Service-specific GitLab projects.
- Our general admin wiki.
- A set of handover notes
If you don't know where to document something, use the general wiki as a general rule of thumb.
Digital Admissions¶
An index of documentation relating to Digital Admissions is maintained in a separate Google doc within the Digital Admissions Shared Drive. The document is open to the entire Digital Admissions team and not just DevOps.
Raven¶
There is a dedicated operational documentation project for Raven.
Identity¶
There is a dedicated operational documentation project for Identity.
General documentation¶
Wider technical standards documentation is in the process of being published on the Technical Design Authority site. It is likely that some application notes may be migrated there in due course.
Information on internal UIS policies and procedures are available on the UIS Intranet site.