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

docs: parameterise documentation site #236

Open
wants to merge 11 commits into
base: next
Choose a base branch
from

Conversation

huynguyen-hl
Copy link
Member

@huynguyen-hl huynguyen-hl commented Mar 11, 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/962

Mobile & Desktop Screenshots/Recordings

Builds and serves the specification site using the default configuration:

image

Builds and serves the specification site using a custom configuration (custom environment variables):

SITE_TITLE=UN Transparency Protocol
SITE_TAGLINE=A comprehensive suite of tools for testing conformance to the UNTP Specification.
SITE_LOGO_URL=img/logo.svg
ORGANIZATION_NAME=uncefact
PROJECT_NAME=tests-untp
FAVICON_URL=img/favicon.ico
HERO_IMAGE_URL=img/un-crm-social-card.png
HERO_IMAGE_ALT=Hero image alt
NAVBAR_TITLE=TP
EDIT_URL_BASE=https://github.com/uncefact/tests-untp/tree/next/documentation
REPOSITORY_LINK=https://github.com/uncefact/tests-untp
SLACK_COMMUNITY_LINK=https://join.slack.com/t/uncefact/shared_invite/zt-1d7hd0js1-sS1Xgk8DawQD9VgRvy1QHQ
SLACK_CHANNEL_LINK=https://app.slack.com/client/T03KNUD7LHZ/C05R8DD2AKZ
ALT_TEXT_IMAGES=Generic image alt text
EXTENSION_DOCS_LINK=https://uncefact.github.io/spec-untp/docs/extensions/
FOOTER_TITLE=UN Transparency Protocol
FOOTER_TEXT=United Nations Economic Commission for Europe
FOOTER_SPEC_TITLE= UNTP Specification
FOOTER_SPEC_LINK=https://uncefact.github.io/spec-untp/
image

Added tests?

  • πŸ‘ yes
  • πŸ™… no, because they aren't needed
  • πŸ™‹ no, because I need help

Added to documentation?

  • πŸ“– Mock App docs site
  • πŸ“œ README.md
  • πŸ“• storybook
  • πŸ™… no documentation needed

Copy link

github-actions bot commented Mar 11, 2025

Code Coverage Report

Lines Statements Branches Functions
Coverage: 82%
81.79% (3572/4367) 69.1% (859/1243) 73.54% (417/567)
Title Lines Statements Branches Functions
All packages Coverage: 82%
81.79% (3572/4367) 69.1% (859/1243) 73.54% (417/567)
Components Coverage: 84%
84.03% (516/614) 69.36% (120/173) 77.23% (95/123)
Mock app Coverage: 71%
71.95% (372/517) 53.23% (74/139) 68.14% (77/113)
Services Coverage: 81%
79.29% (1038/1309) 64.88% (255/393) 75.71% (106/140)
UNTP test suite Coverage: 85%
85.75% (1090/1271) 81.35% (144/177) 67.21% (41/61)
VC test suite Coverage: 100%
100% (20/20) 100% (2/2) 100% (4/4)
UNTP Playground Coverage: 87%
84.92% (569/670) 73.68% (266/361) 75.38% (98/130)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants