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

SR-454: Improve development env w/ Jekyll & Docker #29

Merged
merged 1 commit into from
Feb 24, 2025

Conversation

GormFrank
Copy link
Collaborator

@GormFrank GormFrank commented Feb 19, 2025

Everything is this PR is related to the local development setup, and has no impact on the distribution files. Its purpose is to improve the repository to facilitate contribution and testing. As part of this PR, you'll see that:

  • You can now run a test website locally with Docker.
  • The docker website leverages the remote GCWeb Jekyll theme.
    • Uses a newly added front-matter option for scripts of type module.
  • The website hosted on local server updates itself upon changes to the HTML, CSS and JS files.
  • Search pages work as expected thanks to a new approach with adding an API key as a Jekyll site-wide data variable.
  • It still allows you to build distribution files with linting and other code quality checks with Grunt.
  • It still allows you to spin up GitHub pages on your fork (please do not expose the API key, use the token alternative instead).
  • Improved documentation to guide developement work.
  • Expansion of test pages to include more use cases such as overriding templates for custom ones, as per the maintenance plan forward.
  • Enforces the line ending for CSS build to be linux line ending in the distribution file, as per the maintenance plan forward.

Consequently, this PR has the following relation to other PRs:

@GormFrank GormFrank marked this pull request as ready for review February 20, 2025 03:51
@GormFrank GormFrank changed the title SR-454: Improve developemnt env w/ Jekyll & Docker SR-454: Improve development env w/ Jekyll & Docker Feb 20, 2025
Copy link
Contributor

@duboisp duboisp left a comment

Choose a reason for hiding this comment

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

Reviewed quickly and it looks good to merge.

Comment: There is a possibility to simplify the UI by moving the use of CSS utilities class directly managed via the page master CSS class "page-type-search"

@GormFrank
Copy link
Collaborator Author

Reviewed quickly and it looks good to merge.

Comment: There is a possibility to simplify the UI by moving the use of CSS utilities class directly managed via the page master CSS class "page-type-search"

Thanks for bringing this up, it is in fact on the to do list, but here you are providing an insight on where to start with the CSS selector, and thank you for this.


Based on technical discussions and on the fact that this PR does not affect the distribution files, I will be self-merging.

@GormFrank GormFrank merged commit 71fd3b0 into ServiceCanada:main Feb 24, 2025
1 check passed
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