Skip to content
This repository was archived by the owner on Nov 14, 2025. It is now read-only.

feat: parameterise specification site configuration#322

Open
huynguyen-hl wants to merge 11 commits intomainfrom
feat/parameterise-specification-site-configuration
Open

feat: parameterise specification site configuration#322
huynguyen-hl wants to merge 11 commits intomainfrom
feat/parameterise-specification-site-configuration

Conversation

@huynguyen-hl
Copy link
Copy Markdown
Member

@huynguyen-hl huynguyen-hl commented Mar 10, 2025

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?

@ashleythedeveloper
Copy link
Copy Markdown
Collaborator

Just a note that EDIT_URL_BASE should be https://github.com/uncefact/spec-untp/edit/main/website

Copy link
Copy Markdown
Collaborator

@ashleythedeveloper ashleythedeveloper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work Huy.

Comment thread website/docusaurus.config.js Outdated
Comment thread website/docusaurus.config.js
Comment thread website/docusaurus.config.js Outdated
Comment thread website/README.md Outdated
Comment thread website/README.md

### Build

#### With Default Configuration
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about adding a section below the install command Configuration explaining that the default configuration is sufficient to proceed and will use the default placeholders and that when the user is ready, they can configure the environment variables with a link to environment variable section?

Also, add the location of the example.env within the first paragraph of the environment variables section.

I feel that this effectively communicates that the default values are sufficient, but when ready, here is more information about how to configure the system, which consolidates the configuration step, which is required for both local development and the build.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, the README.md has been updated.

Comment thread website/static/img/default-favicon.png Outdated
Comment thread website/static/img/grey-placeholder-image.jpg Outdated
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants