Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Transparency #40

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Update format
nnagewad committed Nov 18, 2024
commit bebf1a94eb652f8521c6e48cf69ec3aed7fff19b
101 changes: 48 additions & 53 deletions docs/frontend-templates/transparency.md
Original file line number Diff line number Diff line change
@@ -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.

@@ -123,7 +123,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:
@@ -133,12 +133,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.
Contextual breadcrumbs
componentURL: https://components.publishing.service.gov.uk/component-guide/contextual_breadcrumbs
generated:
@@ -148,12 +148,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.
Topics taxonomy tags > Change tags
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.
Page title
componentURL: https://components.publishing.service.gov.uk/component-guide/title
generated:
@@ -163,12 +163,12 @@ components:
# hardcode = "Hardcoded by developer"
publisher
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.
Title (required)
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.
Translation navigation
componentURL: https://components.publishing.service.gov.uk/component-guide/translation_nav
generated:
@@ -178,12 +178,12 @@ components:
# hardcode = "Hardcoded by developer"
publisher
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.
Add translation
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.
Lead paragraph
componentURL: https://components.publishing.service.gov.uk/component-guide/lead_paragraph
generated:
@@ -193,12 +193,12 @@ components:
# hardcode = "Hardcoded by developer"
publisher
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.
Summary (required)
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.
Metadata block
componentURL: https://components.publishing.service.gov.uk/component-guide/metadata
generated:
@@ -208,12 +208,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.
"Can include any of the items under Associations heading"
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.
Single page notification button
componentURL: https://components.publishing.service.gov.uk/component-guide/single_page_notification_button
generated:
@@ -223,13 +223,13 @@ 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.
"The [Devolved Nations (experimental)](https://components.publishing.service.gov.uk/component-guide/devolved_nations) will only appear if the document **does not** apply to all UK nations"
# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information.
'The [Devolved Nations (experimental)](https://components.publishing.service.gov.uk/component-guide/devolved_nations) will only appear if the document **does not** apply to all UK nations'
componentURL:
generated:
# Options how said component is generated page:
@@ -238,13 +238,13 @@ components:
# hardcode = "Hardcoded by developer"
publisher
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.
Excluded nations (required)
8:
# 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.
"[Heading](https://components.publishing.service.gov.uk/component-guide/heading) component is used to list out all the attached documents"
# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information.
'[Heading](https://components.publishing.service.gov.uk/component-guide/heading) component is used to list out all the attached documents'
componentURL:
generated:
# Options how said component is generated page:
@@ -253,12 +253,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.
9:
# 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.
Attachment
componentURL: https://components.publishing.service.gov.uk/component-guide/attachment
generated:
@@ -268,12 +268,12 @@ components:
# hardcode = "Hardcoded by developer"
publisher
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.
Attachments > Title (required) + File (required)
10:
# 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.
Govspeak content
componentURL: https://components.publishing.service.gov.uk/component-guide/govspeak
generated:
@@ -283,12 +283,12 @@ components:
# hardcode = "Hardcoded by developer"
publisher
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.
Body (required)
11:
# 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.
Published dates
componentURL: https://govuk-government-frontend.herokuapp.com/component-guide/published_dates
generated:
@@ -298,12 +298,12 @@ components:
# hardcode = "Hardcoded by developer"
publisher
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.
First published date
12:
# 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.
Print link
componentURL: https://components.publishing.service.gov.uk/component-guide/print_link
generated:
@@ -313,13 +313,13 @@ 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.
13:
# 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.
"[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)"
# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information.
'[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)'
componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component.
generated:
# Options how said component is generated page:
@@ -328,13 +328,13 @@ 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.
14:
# 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.
"[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual footer](https://components.publishing.service.gov.uk/component-guide/contextual_footer)"
# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information.
'[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual footer](https://components.publishing.service.gov.uk/component-guide/contextual_footer)'
componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component.
generated:
# Options how said component is generated page:
@@ -343,12 +343,12 @@ components:
# hardcode = "Hardcoded by developer"
publisher
input:
# You MUST wrap this in double quotation marks (ie. " "), since markdown can be used to enter this information.
"It can include: Taxonomy and any items under the Associations heading"
# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information.
'It can include: Taxonomy and any items under the Associations heading'
15:
# 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:
@@ -358,12 +358,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.
16:
# 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:
@@ -373,7 +373,7 @@ 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.

# Evidence and insights for this frontend template
@@ -382,18 +382,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.