Schools Digital technical documentation
Welcome to the technical documentation for apps and libraries in Schools Digital. This site is used internally in the Department for Education.
Repositories we own
C# apps and dependencies
| Service name | repo | framework | dfe-analytics-net |
|---|---|---|---|
| GIT CRM API | DFE-Digital/get-into-teaching-api | net8.0 | |
| Get Information About Pupils | DFE-Digital/get-information-about-pupils | net8.0 | |
| Get Into Teaching API | DFE-Digital/get-into-teaching-api | net8.0 | |
| Get an identity | DFE-Digital/get-an-identity | net7.0 | 0.1.0 |
| SAP Public | DFE-Digital/sap-public | net8.0 | |
| SAP Sector | DFE-Digital/sap-sector | net8.0 | |
| Teaching record system | DFE-Digital/teaching-record-system | net9.0 |
Rails apps and dependencies
| Service name | repo | rails | ruby | dfe-analytics | dfe-reference-data | dfe-autocomplete |
|---|---|---|---|---|---|---|
| Access your teaching qualifications | DFE-Digital/access-your-teaching-qualifications | 7.2.2.2 | 3.4.4 | 1.14.2 | ||
| Apply for Qualified Teacher Status in England | DFE-Digital/apply-for-qualified-teacher-status | 8.0.3 | 3.4.7 | 1.15.10 | 0.2.0 | |
| Apply for teacher training | DFE-Digital/apply-for-teacher-training | 8.0.3 | 3.4.4 | 1.15.12 | 3.8.6 | 0.1.0 |
| Claim additional payments for teaching | DFE-Digital/claim-additional-payments-for-teaching | 8.1.1 | 3.4.7 | 1.15.9 | ||
| DfE Analytics | DFE-Digital/dfe-analytics | 7.2.2 | 3.1.2 | 1.15.12 | ||
| Early careers framework | DFE-Digital/early-careers-framework | 7.1.5.2 | 3.2.6 | 1.15.9 | ||
| Find a lost TRN | DFE-Digital/find-a-lost-trn | 7.2.2.2 | 3.4.4 | 0.1.0 | ||
| Get Into Teaching website | DFE-Digital/get-into-teaching-app | 8.0.4 | 3.4.7 | 1.15.1 | 3.6.9 | 0.2.1 |
| Get School Experience | DFE-Digital/schools-experience | 7.1.5.2 | 3.4.5 | 1.15.1 | 3.5.0 | 0.1.0 |
| ITT Mentor Services | DFE-Digital/itt-mentor-services | 8.0.2.1 | 3.3.5 | 1.15.9 | ||
| National Professional Qualification registration | DFE-Digital/npq-registration | 7.2.2.2 | 3.4.7 | 1.15.6 | ||
| Publish teacher training courses | DFE-Digital/publish-teacher-training | 8.0.4 | 3.4.2 | 1.15.11 | 0.2.1 | |
| Refer serious misconduct by a teacher | DFE-Digital/refer-serious-misconduct | 7.2.1.1 | 3.4.4 | 1.14.2 | ||
| Register of placement schools | DFE-Digital/register-placement-schools | 8.0.4 | 3.4.4 | |||
| Register trainee teachers | DFE-Digital/register-trainee-teachers | 7.2.3 | 3.4.2 | 1.15.12 | 3.8.6 | |
| Teacher Pay Calculator | DFE-Digital/teacher-pay-calculator | 8.0.2 | 3.4.1 | |||
| Teacher Training Entitlement | DFE-Digital/teacher-training-entitlement | 7.2.2.2 | 3.4.7 | 1.15.6 | ||
| Teaching vacancies | DFE-Digital/teaching-vacancies | 8.0.4 | 3.4.7 | 1.15.12 |
Other repositories
| Service name | repo |
|---|---|
| Database of Qualified Teachers | DFE-Digital/database-of-qualified-teachers |
| DfE Analytics Dataform | DFE-Digital/dfe-analytics-dataform |
| DfE Reference Data | DFE-Digital/dfe-reference-data |
| GOV.UK Markdown | DFE-Digital/govuk_markdown |
| Get Teacher Training Adviser | DFE-Digital/get-teacher-training-adviser-service |
| GitHub Actions | DFE-Digital/github-actions |
| Infrastructure | DFE-Digital/bat-infrastructure |
| Monitoring | DFE-Digital/cf-monitoring |
| Teacher Misconduct System | DFE-Digital/teacher-misconduct-system |
| Teacher Services Cloud | DFE-Digital/teacher-services-cloud |
| Uptime | DFE-Digital/teacher-services-upptime |
Historic services repositories
| Service name | repo |
|---|---|
| BAT Data Maps | DFE-Digital/bat-data-maps |
| Get Into Teaching asset manager | DFE-Digital/GITISContent |
| Find teacher training | DFE-Digital/find-teacher-training |
| Get a Teacher Relocation Payment | DFE-Digital/get-a-teacher-relocation-payment |
Table of contents
Operating a service
Access your teaching qualifications
- 1. Record architecture decisions
- 2. Reuse existing architecture
- 8. Encrypt database fields
- 4. Implement the Check records service as part of AYTQ
- 5. Replace Devise with DSI OAuth for support users
- Architecture
- Azure Storage
- Data Schema
- Deployment
- DfE Sign In
- Encryption
- Puppeteer
- Review apps
- Routing two services
- Testing styleguide
- Updating Ruby
Apply for Qualified Teacher Status in England
- 1. Record architecture decisions
- 2. Reuse existing architecture
- 3. Model countries and regions
- 4. Tracking usage
- 5. Sending emails
- 6. Storing files
- 7. Application forms
- 8. View objects
- 9. Assessments
- 10. GOV.UK One Login
- 9. Prioritisation checks
- Application form fixes
- Application Forms
- Assessment section failure reason updates
- Authentication
- Countries and regions
- History and back links
- Infrastructure
- Setting up analytics
Apply for teacher training
- Support on Apply
- Apply Dev Support Playbook
- 1. Record architecture decisions
- 2. Use Devise for authentication
- 3. Initial data model
- 4. Application architecture
- 5. Application structure
- 6. Retrieving Data from Find Service
- 7. Integration with the Enterprise API Management Gateway
- 8. API extensions mechanism
- 9. Async and scheduled jobs
- 10. Use cookies for sessions
- 11. Storing Diversity Data
- 12. Improve security of the support interface
- 13. Course Option Validity
- 14. Alerting and Monitoring
- 15. Carrying over applications
- 16. Structured GCSE grades
- 17. Application Choice Updated At
- 18. Public ids for qualifications
- 19. JavaScript System Specs
- 20. Strict time control in test suite
- 21. Add TDA Courses to Apply / Manage
- 22. Realistic Job Preview Link Tracking
- 23. Add Active Storage with Azure Storage
- 24. Enabling Work Experience changes
- 25. Redacting personal data fields for local database copies
- 26. Email Click Tracking
Claim additional payments for teaching
- Google BigQuery Integration
- Generate a CSV report of claims that are eligible for a Targeted Retention Incentive top up
- Connect to an instance running in Azure
- Developer onboarding
- DfE Sign-in
- First-line support developer runbook
- Deployment process
- Logging
- Payroll
- Privileged Identity Management (PIM) requests
- Generating School Check Data
- Secrets
Database of Qualified Teachers
Early careers framework
- # Rails secrets management
- # Debugging in GovPaaS
- Feature test setup
- Handling participants moving from a cohort frozen for payments to the active cohort
- Maintenance mode
- Annual changes to pupil premiums and sparsity
- ## Terraform setup
Find a lost TRN
- Change Redis service plan
- Encryption
- Find a lost TRN ops manual
- How to restore database from point in time backup
- Staff Authentication
- Find a lost TRN - Technical Architecture
- 1. Record architecture decisions
- 3. Use a Ruby on Rails monolith
- 4. Use postgres to handle persistence
- 5. Use automated tooling to check for CVEs in dependant packages
- 6. Sidekiq and Redis
- 7. Scheduled Jobs
- 8. Encrypt database fields
- 9. Delete Zendesk tickets
- 10. Support for Get an Identity
Find teacher training
GIT CRM API
Get Information About Pupils
Get Into Teaching API
Get Into Teaching asset manager
Get Into Teaching website
- Codespaces
- Configuration
- Guide to creating content on the Get Into Teaching website
- Deployment
- Development
- Application Disaster Recovery
- Events Portal
- Monitoring
- Sign up journeys
Get School Experience
Get a Teacher Relocation Payment
- Azure Kubernetes Service / AKS cheatsheet
- Understanding Login Functionality
- Form Funnel Analytics
- Report Template
- 1. Record architecture decisions
- 3. Initial data model
- 3. Introduce PageObject via SitePrism for Testing
- 3. Update domain: extract school
- 5. Update domain: extract `Address` domain class
- 6. Update domain: extract Application model
Get an identity
- Account page
- Analytics
- Find a lost TRN integration with the authorization server
- Get an Identity Technical Spikes Summary
- Teacher Services Get an Identity formerly Teacher ID - part of TS Data Transformation
- Register via a magic link
- Importing users into identity
- Webhooks
GitHub Actions
ITT Mentor Services
- Rails Active Job
- Connect to an instance running in Azure
- Conventions
- Data model
- Deactivate school
- Environment Variables in Azure
- Feature flags
- Incident Cheatsheet
Infrastructure
Monitoring
Publish teacher training courses
Refer serious misconduct by a teacher
- 1. Record architecture decisions
- 2. Reuse existing architecture
- 3. Using email-based OTP for user sign in
- 4. Model most things directly on the Referral model
- Privileged Identity Management (PIM) requests
- Testing styleguide
Register trainee teachers
- Azure Kubernetes Service / AKS cheatsheet
- # AKS terraform modules
- Alerting and Monitoring
- API Monitoring Guide for Register
- API Technical Guidance
- Active Record Encryption Setup
- Authentication
- big_query_setup
- Developing in GitHub Codespaces
- Configuration
- Creating a new environment
- Disaster recovery
- Emails
- Healthcheck and Ping Endpoints
- Logging Documentation
- Machine setup
- OpenAPI integration
- Qualtrics
- Installation
- Smoke Tests
- Support Playbook
- Testing & Linting
- Testing Data Migrations
- Importing funding data from CSVs
- 1. Record architecture decisions
- 2. Use adr-tools with custom template
- 3. Connections to DTTP Dynamics
- 4. Non-integer trainee IDs
- 5. Store invalid data in a column against ApplyApplication
- 5. Academic Cycles
- 7. Store academic cycles on trainees
- 8. Enable course year picker
- 9. Enable Sidekiq worker on productiondata
- 10. Use token authentication for API access
- 11. Load testing
- 12. Rename Lead Partner to Training Partner
- 13. Rename ‘awarded’ to ‘holds’
Teacher Misconduct System
- Teacher Misconduct System Architecture
- Process for Dynamics CRM evergreen upgrades
- TMS testing strategy (as of February 2022)
- TMS user support process (as of February 2022)
Teacher Services Cloud
- Ingress Controller Upgrade
- Log Analytics
- AKS upgrade
- Azure GCP Workload Identity Federation
- # Developer onboarding
- Disaster Recovery testing
- Disaster recovery
- Front door certificate revalidation
- GitHub Workflows and Security
- Grafana Monitoring
- HTTP request
- Shipping application logs to Logit.io
- Low Priority application
- Maintenance page
- Monitoring
- Node filesystems
- Migrating Workloads to a New Node Pool
- Teacher services infra - Service onboarding form
- Onboard a new service to the Teacher Services AKS cloud platform
- Platform FAQ
- Platform set-up
- Postgres FAQ
- Postgres major version upgrade
- Production checklist
- Kubernetes cluster Public IPs
- Rebuild AKS cluster with zero downtime
- Slack webhook integration
- SNAT ports
Teacher Training Entitlement
- acquiring_new_private_childcare_provider_data
- admins
- Connect to an instance running in Azure
- data_model
- dfe_analytics
- # NPQ Eligibility Lists
- environments
- feature_flags
- funding
- get_an_identity
- how_does_tte_work
- importing_data
- logging
- maintenance_mode
- qualifications_api
- sending_emails
- setup
- specs_and_linting
- Swagger
- TTE Contracts
Teaching record system
- Using Kubernetes to connect to dev/pre-prod environments
- Logical Data Model
- Logical Data Model
- Teaching Reference Number (TRN)
- Data Integrations
- TRS Data Sources
- High level flow of signing in to a service that requires authorisation to the teaching record via GOV.UK One Login
- Technical Architecture
Teaching vacancies
- Use postcodes.io to get postcode from coordinates
- Replace Google Sheets with Big Query as a reporting database
- Replace Gitflow with Simple Git Workflow
- Environments after GOV.UK PaaS migration
- Switch from ElasticSearch to Algolia for search functionality
- Use Devise for authentication
- Continue to use Algolia as search engine
- 0009_build_job_applications_rather_than_buy_cots
- Migrate from Algolia to Postgres-based search
- Encourage use of devcontainers for local development
- Use Mermaid for diagrams
External contributions
It’s highly recommended and encouraged to contribute to open source projects that we use. Here’s some of the things we’ve done:
- Added new tag styles to the Design System
- Created GOV.UK Design System community resources repo
- Improved the grammar in Design System documentation
- Improved the DfE form builder
- Improved the GOV.UK Notify ruby client
- Improved the GOV.UK Notify Rails integration
- Improved the GOV.UK Rubocop configuration
- Improved the MoJ frontend toolkit
- Improved the tech docs template docs