From fd60f80a3690b96d769577b200793ab59658134f Mon Sep 17 00:00:00 2001
From: rmccar <42928680+rmccar@users.noreply.github.com>
Date: Tue, 8 Oct 2024 12:54:37 +0100
Subject: [PATCH] Format migration guide (#3377)
---
.../70.x.x-to-71.0.0-migration-guide.md | 178 +++++++++---------
1 file changed, 93 insertions(+), 85 deletions(-)
diff --git a/migration_guides/70.x.x-to-71.0.0-migration-guide.md b/migration_guides/70.x.x-to-71.0.0-migration-guide.md
index 958bbf0819..0a3e062a59 100644
--- a/migration_guides/70.x.x-to-71.0.0-migration-guide.md
+++ b/migration_guides/70.x.x-to-71.0.0-migration-guide.md
@@ -73,6 +73,7 @@ This section will list the changes that will impact more than one component
- Video - `videoLinkURL` will need to be renamed `videoLinkUrl`
- Page Template - `assetsURL` will need to be renamed `assetsUrl`
- Footer - `OGLLink` will need to be renamed `oglLink`
+ - Footer - `oglLink.HTML` will need to be renamed `oglLink.html`
- Message - `messageID` will need to be renamed `messageId`
- Access Code - `maxlength` will need to be renamed `maxLength`
- Address input - `APIDomain` will need to be renamed `apiDomain`
@@ -125,6 +126,7 @@ This section will list the changes that will impact more than one component
}
})
}}
+
NEW
{{
onsHeader({
@@ -196,12 +198,12 @@ This section will list the changes that will impact more than one component
OLD
- NEW
-
-
+ >
+
+ NEW
+
```
@@ -249,7 +251,7 @@ This section will list all the changes that are specific to one component.
OLD
{% from "components/onsMetadata/_macro.njk" import onsMetadata %}
- {{-
+ {{
onsMetadata({ ... })
}}
@@ -257,7 +259,7 @@ This section will list all the changes that are specific to one component.
{% from "components/description-list/_macro.njk" import onsDescriptionList %}
{{
- onsDescriptionList({ ... })
+ onsDescriptionList({ ... })
}}
```
@@ -293,6 +295,7 @@ This section will list all the changes that are specific to one component.
}
})
}}
+
SUGGESTED REPLACEMENT
{% from "components/button/_macro.njk" import onsButton %}
@@ -358,16 +361,17 @@ This section will list all the changes that are specific to one component.
{{
onsMessageList({
"messages": [{
- "url": "#0",
- "subject": "survey response query",
+ "url": "#0",
+ "subject": "survey response query",
}]
})
}}
+
NEW
{{
onsMessageList({
- "messages": [{
- "subject":{
+ "messages": [{
+ "subject":{
"url": "#0",
"text":"survey response query",
}
@@ -401,6 +405,7 @@ This section will list all the changes that are specific to one component.
"poweredBy": ""
})
}}
+
NEW
{{
onsFooter({
@@ -436,19 +441,19 @@ This section will list all the changes that are specific to one component.
OLD
{{-
onsFooter({
- "OGLLink": {
- "link": "www.google.com"
- }
- })
+ "OGLLink": {
+ "link": "www.google.com"
+ }
+ })
}}
NEW
{{
onsFooter({
- "OGLLink": {
- "text": "www.google.com"
- }
- })
+ "OGLLink": {
+ "text": "www.google.com"
+ }
+ })
}}
```
@@ -580,7 +585,7 @@ This section will list all the changes that are specific to one component.
- `summary.summaryTitle` is renamed to `summary.title`
- `group.groupTitle` is renamed to `group.title`
- `row.rowTitle` is renamed to `row.title`
- - `row.rowItems` is renamed to `row.items`
+ - `row.rowItems` is renamed to `row.itemsList`
- `rowItem.rowTitle` is renamed to `item.title`
- `rowItem.rowTitleAttributes` is renamed to `item.titleAttributes`
- **Reason for change:** In this update, we are addressing an inconsistency in the naming of parameters within the summary component. This change aims to standardise the parameter names for clarity and consistency.
@@ -632,6 +637,7 @@ This section will list all the changes that are specific to one component.
]
})
}}
+
NEW
{{
onsSummary({
@@ -646,7 +652,7 @@ This section will list all the changes that are specific to one component.
{
"id": "sales-dates-row",
"title": "What are the dates of the sales period you are reporting for?",
- "items": [
+ "itemsList": [
{
"id": "sales-dates",
"valueList": [
@@ -699,6 +705,7 @@ This section will list all the changes that are specific to one component.
"titleTag": "h3"
})
}}
+
NEW
{{
onsTimeline({
@@ -732,35 +739,35 @@ This section will list all the changes that are specific to one component.
Click for example
```njk
- OLD
- {{
- onsDocumentList({
- "url": '#0',
- "title": 'ONS launches Integrated Data Service to boost government collaboration on data sharing',
- "metadata": {
- "type": {
- "text": 'Press releases',
- "ref": 'Ref 008052'
- },
- },
- })
- }}
-
- NEW
- {{
- onsDocumentList({
- "title": {
- "text": 'ONS launches Integrated Data Service to boost government collaboration on data sharing',
- "url": '#0'
- },
- "metadata": {
- "object": {
- "text": 'Press releases',
- "ref": 'Ref 008052'
- },
- },
- })
- }}
+ OLD
+ {{
+ onsDocumentList({
+ "url": '#0',
+ "title": 'ONS launches Integrated Data Service to boost government collaboration on data sharing',
+ "metadata": {
+ "type": {
+ "text": 'Press releases',
+ "ref": 'Ref 008052'
+ },
+ },
+ })
+ }}
+
+ NEW
+ {{
+ onsDocumentList({
+ "title": {
+ "text": 'ONS launches Integrated Data Service to boost government collaboration on data sharing',
+ "url": '#0'
+ },
+ "metadata": {
+ "object": {
+ "text": 'Press releases',
+ "ref": 'Ref 008052'
+ },
+ },
+ })
+ }}
```
@@ -782,19 +789,19 @@ This section will list all the changes that are specific to one component.
Click for example
```njk
- OLD
- {{
- onsCookiesBanner({
- "settingsLinkTextURL": "/cookiesoverride",
- })
- }}
-
- NEW
- {{
- onsCookiesBanner({
- "settingsLinkURL": "/cookiesoverride",
- })
- }}
+ OLD
+ {{
+ onsCookiesBanner({
+ "settingsLinkTextURL": "/cookiesoverride",
+ })
+ }}
+
+ NEW
+ {{
+ onsCookiesBanner({
+ "settingsLinkURL": "/cookiesoverride",
+ })
+ }}
```
@@ -855,21 +862,21 @@ This section will list all the changes that are specific to one component.
"url": '#0'
"headingLevel": 2,
"titleClasses": "random-class"
- },
- "body":{
- "id": 'text',
- "text": 'How we keep your data safe and what happens to your personal information.',
- "itemsList": [
- {
- "url": '#0',
- "text": 'List item 1 about the census'
- },
- {
- "url": '#0',
- "text": 'List item 2 about the census'
- }
- ]
- }
+ },
+ "body":{
+ "id": 'text',
+ "text": 'How we keep your data safe and what happens to your personal information.',
+ "itemsList": [
+ {
+ "url": '#0',
+ "text": 'List item 1 about the census'
+ },
+ {
+ "url": '#0',
+ "text": 'List item 2 about the census'
+ }
+ ]
+ }
})
}}
```
@@ -936,12 +943,13 @@ This section will list all the changes that are specific to one component.
"itemsList": [{
"title": "Section 1"
"anchors": [{
- "title": "Sub section 1"
- }]
+ "title": "Sub section 1"
}]
}]
- })
+ }]
+ })
}}
+
NEW
{{
onsSectionNavigation({
@@ -949,11 +957,11 @@ This section will list all the changes that are specific to one component.
"itemsList": [{
"text": "Section 1"
"anchors": [{
- "text": "Sub section 1"
- }]
+ "text": "Sub section 1"
}]
}]
- })
+ }]
+ })
}}
```