diff --git a/source/data-operations-manual.html.md.erb b/source/data-operations-manual.html.md.erb index 4b92f6f..2f014d5 100644 --- a/source/data-operations-manual.html.md.erb +++ b/source/data-operations-manual.html.md.erb @@ -50,11 +50,16 @@ to the collection. Make a note of the location. The following columns need to be - `pipelines` - the pipelines that need to be ran on resources collected from this endpoint. These are equivalent to the datasets and where more than one is neccessaary they should be separated by `;` - `organisation` - the organisation which the endpoint belongs to. The name should be in [this list](https://datasette.planning.data.gov.uk/digital-land/organisation) -If you haven't been given some of the above information then reach out to the data manager or tech lead for advise. +If you haven't been given some of the above information then reach out to the data manager or tech lead for advice. You can use the below to get you started: + +```text +organisation, endpoint-url, documentation-url, start-date, pipelines, plugins +``` #### 4. run `add_endpoint_and_lookups_cmd` Run the following command from inside the repository with the virtual env created in step 2 activated. + As a minimum you'll need to include the path to the input csv generated in step 3. and the name of the collection that your working in. Note: collection name can be retrieved from the repository name. if your working in the `conservation-area-collection` repo then you would use `conservation-area` diff --git a/source/runbook.html.md.erb b/source/runbook.html.md.erb index f0471e8..f6ddd25 100644 --- a/source/runbook.html.md.erb +++ b/source/runbook.html.md.erb @@ -119,6 +119,15 @@ Async on slack: At 5.09 on Friday the 29th of September, Paul Downey posted in the main Slack channel that the url param key for the dataset has changed from dataset to layer. He advised that this needed reverting, and any urls pointing to the old key needed to be redirected. +Example of original format: + +`https://www.planning.data.gov.uk/map/?dataset=infrastructure-project` + +Example of new, unexpected format: + +`https://www.planning.data.gov.uk/map/?layer=infrastructure-project` + + #### Running log * George started investigations at 9.11am on the 2nd October, finding that the specified key for the dataset param had @@ -130,16 +139,26 @@ been overwritten as part of the refactor/map component update here: https://gith * These changes were reviewed, approved and merged by Mark at 11:08 and available on the live site a few minutes later. +#### Impact + +Links with the now non-functioning format had gone out as a part of the weeknote shared by senior management, including to a minister-level audience. Matt Lucht identified a quick workaround, to make a new URL that included both sets of data: + +`https://www.planning.data.gov.uk/map/?dataset=infrastructure-project&layer=infrastructure-project` + #### Analysis -We did not appreciate that people were using the direct link off the browser to access the map. -When applying updates to the map code, we overwrote the code that specified the dataset url param key. This change was not picked up in manual testing or code reviews. There were no automated tests covering this case, and as the change was inadvertent, we did not write any new ones. +We did not appreciate that people were using and sharing the direct link off the browser to access the map. + +When applying updates to the map code, we overwrote the section that specified the `dataset` url param key and replaced it with `layer`. This change was not picked up in manual testing or code reviews. There were no automated tests covering this case, and as the change was inadvertent, we did not write any new ones. + +### Post incident actions + +We are implementing a better set of automated tests to reduce the likelihood of this happening again. #### Lessons to be learned The original change came in as part of a much largeer set of code changes. It was not noticed in code review. Code reviews are not as effective when dealing with extensive changes. Next time, let us find ways to not create large pull-requests with hundreds of lines of changes. - ### maptiler started returning 403 errors - 2023-08-16 #### In attendance