Skip to content

Commit

Permalink
Overlay Components (#34)
Browse files Browse the repository at this point in the history
* Making item cats and labels standardised.

The html components now rely on the yml data to populate the details such as the text, style and links. Some new parameters allow these can be overridden for use in overlay views.

* Update categoryLabels.yml

* Update categoryItem.html

* Update categoryItem.html

* Update icons.svg

adding downstream infra icon

* Mapped the descriptive text for each category to data file.

Renamed the categoryItems.yml to carbonStandard.yml to encapsulate all the things in the standard.

* making the infographic reusable with a variant template

* Adding TCS views

* Create template-view.yml

Adding a template file for duplicating and using for overlay views.

* Publishing the category items and carbon standard components

But marking the views and nav as unpublished until we're ready to do so.

* Update _data/overlays/template-view.yml

Co-authored-by: Matthew Griffin <[email protected]>

* Update pages/views/views.md

Co-authored-by: Matthew Griffin <[email protected]>

* Update pages/views/roles/architecture.md

Co-authored-by: Matthew Griffin <[email protected]>

* Update _data/overlays/architecture.yml

Co-authored-by: Matthew Griffin <[email protected]>

* Update pages/views/roles/architecture.md

Co-authored-by: Matthew Griffin <[email protected]>

* Update pages/views/roles/architecture.md

Co-authored-by: Matthew Griffin <[email protected]>

* Update pages/views/roles/architecture.md

Co-authored-by: Matthew Griffin <[email protected]>

* Update _data/overlays/architecture.yml

Co-authored-by: Matthew Griffin <[email protected]>

* Update pages/views/roles/architecture.md

Co-authored-by: Matthew Griffin <[email protected]>

* Update pages/views/roles/architecture.md

Co-authored-by: Matthew Griffin <[email protected]>

* Update pages/views/roles/architecture.md

Co-authored-by: Matthew Griffin <[email protected]>

* Update pages/views/roles/architecture.md

Co-authored-by: Matthew Griffin <[email protected]>

---------

Co-authored-by: Matthew Griffin <[email protected]>
  • Loading branch information
dkrees and mgriffin-scottlogic authored Jun 3, 2024
1 parent de49ce1 commit 8c2e19d
Show file tree
Hide file tree
Showing 8 changed files with 449 additions and 27 deletions.
2 changes: 2 additions & 0 deletions _data/carbonStandard.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
# - link: Creates a link to another page (further details). These are setup by default to the relevant pages, but may be overridden for specific use cases, typically in the overlay views (optional, but defaults to a page).
# - noLink: Provides an overide to prevent any navigation to a page. Renders the component in a <div> instead of an <a>.

title: Technology Carbon Standard

CatU:
description: Upstream emissions relating to the embodied carbon of hardware and the development of software.

Expand Down
4 changes: 3 additions & 1 deletion _data/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@
link: /
- name: Impact Categories
link: /categories
# - name: Views # TO BE PUBLSIHED WITH RESPECTIVE PAGES
# link: /views
- name: Resources
link: /resources
- name: Glossary
link: /glossary
- name: About
link: /about
link: /about
72 changes: 72 additions & 0 deletions _data/overlays/architecture.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Optionally change the title of the infographic. Defaults to the carbonStandard.title otherwise.
title:

CatUSoftware:
selected: true
description: Strategy around COTS/OSS vs in-house. Use green vendors.
link: '#Software'

CatUEmployeeHardware:
selected: true
description: Renewal cycles, recycling, low carbon hardware.
link: '#EmployeeHardware'

CatUNetworkHardware:
selected: true
description: Renewal cycles, recycling, low carbon hardware.
link: '#NetworkHardware'

CatUServerHardware:
selected: true
description: Renewal cycles, recycling, low carbon hardware.
link: '#ServerHardware'

CatOServers:
selected: true
description: Virtualisation or containerisation strategy.
link: "#Servers"

CatONetworkDevices:
selected: true
description: Principles around maximum utilisation.
link: '#NetworkDevices'

CatOEmployeeDevices:
selected: true
description: Apply Power Management configuration.
link: '#EmployeeDevices'

CatGGenerators:
selected: false
description:
noLink: true

CatCCloud:
selected: true
description: Promote low energy architecture and monitoring.
link: '#Cloud'

CatCSaas:
selected: true
description: Create a vendor strategy and minimise API use.
link: '#Saas'

CatCManaged:
selected: true
description: IaaS vendor strategy.
link: '#Managed'

CatDEndUserDevices:
selected: true
description: Promote patterns to minimise energy. Consider framework choices.
link: '#EndUserDevices'

CatDNetworkDataTransfer:
selected: true
description: API design to reduce network traffic. Promote push over polling.
link: '#NetworkTransfer'

CatDInfrastructure:
selected: true
description:
link: '#Infrastructure'
93 changes: 93 additions & 0 deletions _data/overlays/template-view.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
# All the category items are optional. Anything values removed or left empty will fallback to the master 'caronStandard.yml' file.

# Optionally change the title of the infographic. Defaults to the carbonStandard.title otherwise.
title:

# selected (boolean) - to highlight the category item. Used in overlay views to bring attention to the item. (default: false)
# description (string) - adds a descriptive text to the item. Useful for adding additional context. Please keep as short as possible. (default: empty)
# link (string) - a url passed to the item to make it a link. Useful for linking to sections in the same page. (default: defers to the master category page link)
# noLink - set to true to prevent linking to anything at all. This overrides the default link. (default: false)

CatUSoftware:
selected: false
description:
link:
noLink: false

CatUEmployeeHardware:
selected: false
description:
link:
noLink: false

CatUNetworkHardware:
selected: false
description:
link:
noLink: false

CatUServerHardware:
selected: false
description:
link:
noLink: false

CatOServers:
selected: false
description:
link:
noLink: false

CatONetworkDevices:
selected: false
description:
link:
noLink: false

CatOEmployeeDevices:
selected: false
description:
link:
noLink: false

CatGGenerators:
selected: false
description:
noLink:
noLink: false false

CatCCloud:
selected: false
description:
link:
noLink: false

CatCSaas:
selected: false
description:
link:
noLink: false

CatCManaged:
selected: false
description:
link:
noLink: false

CatDEndUserDevices:
selected: false
description:
link:
noLink: false

CatDNetworkDataTransfer:
selected: false
description:
link:
noLink: false

CatDInfrastructure:
selected: false
description:
link:
noLink: false
Loading

0 comments on commit 8c2e19d

Please sign in to comment.