Skip to content

feat: parameterise specification site configuration

Administrator requested to merge feat/parameterise-specification-site-configuration into main

Created by: huynguyen-hl

What type of PR is this? (check all applicable)

  • 🍕 Feature
  • 🐛 Bug Fix
  • 📝 Documentation Update
  • 🎨 Style
  • 🧑‍💻 Code Refactor
  • 🔥 Performance Improvements
  • ✅ Test
  • 🤖 Build
  • 🔁 CI
  • 📦 Chore (Release)
  • ⏩ Revert

Description

This PR aims to parameterize the specification site's branding elements and external links using environment variables with default placeholders. Now, the specs site will have a default mode, serving a generic configuration instead of specific UNTP information.

Related Tickets & Documents

https://github.com/gs-gs/fa-ag-trace/issues/963

Mobile & Desktop Screenshots/Recordings

Builds and serves the UNTP Specification Site using the default configuration:

image

Builds and serves the UNTP Specification Site using a custom configuration (custom environment variables):

# .env
SITE_TITLE=UN Transparency Protocol
SITE_TAGLINE=Supporting governments and industry on practical measures to counter greenwashing by implementing supply chain traceability and transparency at the scale needed to achieve meaningful impacts on global sustainability outcomes.
FAVICON=img/favicon.ico
SITE_URL=https://uncefact.github.io
BASE_URL= /spec-untp/
ORGANIZATION_NAME=uncefact
PROJECT_NAME=spec-untp
EDIT_URL_BASE=https://github.com/uncefact/spec-untp/edit/main/website
SLACK_LINK=https://join.slack.com/t/uncefact/shared_invite/zt-1d7hd0js1-sS1Xgk8DawQD9VgRvy1QHQ
MAILING_LIST_LINK=https://groups.google.com/g/transparency-uncefact
SOCIAL_IMAGE=img/social-card.png
HERO_IMAGE=img/home-hero.jpg
HERO_IMAGE_ALT=UNTP home hero image
NAVBAR_TITLE=TP
LOGO_ALT=United Nations Transparency Protocol
SITE_LOGO=img/logo.svg
REPO_LINK=https://github.com/uncefact/spec-untp
FOOTER_PDF_LINK=/un-transparency-protocol.pdf
FOOTER_TEXT=United Nations Economic Commission for Europe
image

Added tests?

  • 👍 yes
  • 🙅 no, because they aren't needed
  • 🙋 no, because I need help

Added to documentation?

Edited by Ashley HARWOOD

Merge request reports