feat: parameterise specification site configuration#322
feat: parameterise specification site configuration#322huynguyen-hl wants to merge 11 commits intomainfrom
Conversation
|
Just a note that |
ashleythedeveloper
left a comment
There was a problem hiding this comment.
Nice work Huy.
|
|
||
| ### Build | ||
|
|
||
| #### With Default Configuration |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Yep, the README.md has been updated.
…ult values [skip ci]
What type of PR is this? (check all applicable)
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:
Builds and serves the UNTP Specification Site using a custom configuration (custom environment variables):
Added tests?
Added to documentation?