Browse Source

Add some background about the service

pull/696/head
baarkerlounger 3 years ago
parent
commit
c82d1fb878
  1. 9
      README.md
  2. 0
      docs/exports.md
  3. BIN
      docs/images/architecture.png
  4. 0
      docs/images/logs_list.png

9
README.md

@ -15,6 +15,7 @@ Ruby on Rails app that handles the submission of lettings and sales of social ho
- [Monitoring, logging & alerting](docs/monitoring.md)
- [Frontend](docs/frontend.md)
- [Testing strategies and style guide](docs/testing.md)
- [Export to CDS](docs/exports)
## API documentation
@ -23,4 +24,10 @@ API documentation can be found here: <https://communitiesuk.github.io/mhclg-data
## Service
![View of the logs list](docs/screenshots/logs_list.png)
All lettings and and sales of social housing in England need to be logged with the Department for levelling up, housing and communities (DLUHC). This is done by Local Authorities and Housing Associations, who are the primary users of this service. Data is collected via a form that runs on an annual data collection window basis. Form changes are made annually to add new questions, remove any that are no longer needed, or adjust wording or answer options etc. Each data collection window runs from 1st April to 1st April + an extra 3 months to allow for any late submissions, meaning that between April and July, two collection windows are open simultaneously and logs can be submitted for either.
ADD (Analytics & Data Directorate) statisticians are the other primary users of the service. The data collected is transferred to DLUHCs data warehouse (CDS - consolidated data store), via nightly exports to XML which are transferred to S3 and ingested from there. CDS ingests and transforms the data, ultimately storing it in a MS SQL database and exposing it to analysts and statisticians via Amazon Workspaces.
![View of system architecture](docs/images/architecture.png)
![View of the logs list](docs/images/logs_list.png)

0
docs/exports.md

BIN
docs/images/architecture.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 639 KiB

0
docs/screenshots/logs_list.png → docs/images/logs_list.png

Before

Width:  |  Height:  |  Size: 286 KiB

After

Width:  |  Height:  |  Size: 286 KiB

Loading…
Cancel
Save