From ff1ecbb003fe1b4aea2ac13fe94373f42249d9fe Mon Sep 17 00:00:00 2001 From: nnagewad Date: Tue, 10 Sep 2024 11:42:37 +0100 Subject: [PATCH 1/4] Document the travel index frontend template --- .../frontend-templates/travel-advice-index.md | 253 ++++++++++++++++++ 1 file changed, 253 insertions(+) create mode 100644 docs/frontend-templates/travel-advice-index.md diff --git a/docs/frontend-templates/travel-advice-index.md b/docs/frontend-templates/travel-advice-index.md new file mode 100644 index 00000000..cc9bbb12 --- /dev/null +++ b/docs/frontend-templates/travel-advice-index.md @@ -0,0 +1,253 @@ +--- +# This file is a template to document a new frontend template within the GOV.UK Design Library website. +layout: frontend-template-documentation +sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Design Library website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the design library. +# eleventyExcludeFromCollections: true + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. +eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" + parent: Frontend templates + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. +title: Travel advice index + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. +description: #Delete this comment before entering the description of the frontend template. + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). +howItWorks: + #Delete this comment before entering how this frontend template works. + +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. +examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # Both title and link are REQUIRED in order for this information to render on the page. + title: Foreign travel advice + link: https://www.gov.uk/foreign-travel-advice + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. +contentDataLink: https://content-data.publishing.service.gov.uk/content?submitted=true&date_range=past-30-days&search_term=&document_type=travel_advice_index&organisation_id=all + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. +contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. + title: travel_advice_index + link: https://docs.publishing.service.gov.uk/content-schemas/travel_advice_index.html + +contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. + title: travel_advice_index + link: https://docs.publishing.service.gov.uk/document-types/travel_advice_index.html + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + travel advice publisher + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + frontend + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. +components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + Layout super navigation header + componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto + input: + # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + 1: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + Page title + componentURL: https://components.publishing.service.gov.uk/component-guide/title + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode + input: + # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + 2: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + Lead paragraph + componentURL: https://components.publishing.service.gov.uk/component-guide/lead_paragraph + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode + input: + # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + 3: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + Form input with search icon + componentURL: https://components.publishing.service.gov.uk/component-guide/input/with_search_icon + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode + input: + # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + 4: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + Subscription links + componentURL: https://components.publishing.service.gov.uk/component-guide/subscription_links + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + # Delete this comment before enter how this component is generated on the page. + input: + # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + 5: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + Feedback + componentURL: https://components.publishing.service.gov.uk/component-guide/feedback + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto + input: + # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + 6: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + Layout footer + componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto + input: + # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + 7: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + "The large number on the page is not using the [Big number](https://components.publishing.service.gov.uk/component-guide/big_number) component" + componentURL: + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode + input: + # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. +insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # Both title and link are REQUIRED in order for this information to render on the page. + title: #Delete this comment before entering the name of the insight document. + link: #Delete this comment before entering the URL of the insight document. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Doc, (2) Google Sheets, and (3) Google Slides. + description: + # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + #Delete this comment before entering a brief summary about the document being referred. + date: #Delete this comment before entering the date when the document was published. + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. +issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. +--- \ No newline at end of file From 632a12dfffdadd6ee2406b5302f6e86da500c1cc Mon Sep 17 00:00:00 2001 From: nnagewad Date: Mon, 18 Nov 2024 14:32:20 +0000 Subject: [PATCH 2/4] Update format --- .../frontend-templates/travel-advice-index.md | 23 ++++++++----------- 1 file changed, 9 insertions(+), 14 deletions(-) diff --git a/docs/frontend-templates/travel-advice-index.md b/docs/frontend-templates/travel-advice-index.md index cc9bbb12..4ac62a2b 100644 --- a/docs/frontend-templates/travel-advice-index.md +++ b/docs/frontend-templates/travel-advice-index.md @@ -1,12 +1,12 @@ --- -# This file is a template to document a new frontend template within the GOV.UK Design Library website. +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates -# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Design Library website. +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. # When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) -# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the design library. +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. # eleventyExcludeFromCollections: true # Step 3: Establish the relationship of this frontend template. @@ -32,7 +32,7 @@ figmaLink: #Delete this comment before entering the Figma embed URL of the Figma # How the frontend template works # Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. -# You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). howItWorks: #Delete this comment before entering how this frontend template works. @@ -229,18 +229,13 @@ insights: # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: # Both title and link are REQUIRED in order for this information to render on the page. - title: #Delete this comment before entering the name of the insight document. - link: #Delete this comment before entering the URL of the insight document. - documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Doc, (2) Google Sheets, and (3) Google Slides. + date: #Delete this comment before entering the date when the document was published. description: - # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). #Delete this comment before entering a brief summary about the document being referred. - date: #Delete this comment before entering the date when the document was published. - -# How to report an issue with this frontend template -# This will display instrucions on how to report an issue via GitHub. -# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. -githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + title: #Delete this comment before entering the name of the insight document. + link: #Delete this comment before entering the URL of the insight document. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. # Existing issues with this frontend template # List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. From 8e56964896910906fb0aa58ee6ddce487353408d Mon Sep 17 00:00:00 2001 From: nnagewad Date: Mon, 18 Nov 2024 14:49:10 +0000 Subject: [PATCH 3/4] Update single quotation marks --- .../frontend-templates/travel-advice-index.md | 32 +++++++++---------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/frontend-templates/travel-advice-index.md b/docs/frontend-templates/travel-advice-index.md index 4ac62a2b..f913f2a1 100644 --- a/docs/frontend-templates/travel-advice-index.md +++ b/docs/frontend-templates/travel-advice-index.md @@ -105,7 +105,7 @@ components: 0: # The componentName is REQUIRED in order for this information to be displayed on the page. componentName: - # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. Layout super navigation header componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header generated: @@ -115,12 +115,12 @@ components: # hardcode = "Hardcoded by developer" auto input: - # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 1: # The componentName is REQUIRED in order for this information to be displayed on the page. componentName: - # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. Page title componentURL: https://components.publishing.service.gov.uk/component-guide/title generated: @@ -130,12 +130,12 @@ components: # hardcode = "Hardcoded by developer" hardcode input: - # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 2: # The componentName is REQUIRED in order for this information to be displayed on the page. componentName: - # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. Lead paragraph componentURL: https://components.publishing.service.gov.uk/component-guide/lead_paragraph generated: @@ -145,12 +145,12 @@ components: # hardcode = "Hardcoded by developer" hardcode input: - # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 3: # The componentName is REQUIRED in order for this information to be displayed on the page. componentName: - # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. Form input with search icon componentURL: https://components.publishing.service.gov.uk/component-guide/input/with_search_icon generated: @@ -160,12 +160,12 @@ components: # hardcode = "Hardcoded by developer" hardcode input: - # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 4: # The componentName is REQUIRED in order for this information to be displayed on the page. componentName: - # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. Subscription links componentURL: https://components.publishing.service.gov.uk/component-guide/subscription_links generated: @@ -175,12 +175,12 @@ components: # hardcode = "Hardcoded by developer" # Delete this comment before enter how this component is generated on the page. input: - # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 5: # The componentName is REQUIRED in order for this information to be displayed on the page. componentName: - # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. Feedback componentURL: https://components.publishing.service.gov.uk/component-guide/feedback generated: @@ -190,12 +190,12 @@ components: # hardcode = "Hardcoded by developer" auto input: - # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 6: # The componentName is REQUIRED in order for this information to be displayed on the page. componentName: - # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. Layout footer componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer generated: @@ -205,12 +205,12 @@ components: # hardcode = "Hardcoded by developer" auto input: - # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 7: # The componentName is REQUIRED in order for this information to be displayed on the page. componentName: - # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. "The large number on the page is not using the [Big number](https://components.publishing.service.gov.uk/component-guide/big_number) component" componentURL: generated: @@ -220,7 +220,7 @@ components: # hardcode = "Hardcoded by developer" hardcode input: - # You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information. + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. # Evidence and insights for this frontend template From 91a5bdb572d64aa4bb32b203e3b89abbf27828c9 Mon Sep 17 00:00:00 2001 From: nnagewad Date: Mon, 18 Nov 2024 15:53:41 +0000 Subject: [PATCH 4/4] Update quotation marks --- docs/frontend-templates/travel-advice-index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/frontend-templates/travel-advice-index.md b/docs/frontend-templates/travel-advice-index.md index f913f2a1..2c4145ab 100644 --- a/docs/frontend-templates/travel-advice-index.md +++ b/docs/frontend-templates/travel-advice-index.md @@ -211,7 +211,7 @@ components: # The componentName is REQUIRED in order for this information to be displayed on the page. componentName: # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. - "The large number on the page is not using the [Big number](https://components.publishing.service.gov.uk/component-guide/big_number) component" + 'The large number on the page is not using the [Big number](https://components.publishing.service.gov.uk/component-guide/big_number) component' componentURL: generated: # Options how said component is generated page: