search

wet-boew / gcweb-jekyll

This repo is intended to be used as a GitHub template. Its documentation is coming soon.
https://wet-boew.github.io/gcweb-jekyll/
MIT License
9 stars 22 forks source link

Latest renaming/removal of layouts introduce breaking changes that should be documented #21

Open anthonyfok opened 3 years ago

anthonyfok commented 3 years ago

@duboisp, As reported in canada-ca/canada-ca-jekyll-boilerplate#11, the latest 2021-02-15 commit f66348c wet-boew/gcweb-jekyll breaks canada-ca/canada-ca-jekyll-boilerplate and probably many existing sites based on that boilerplate.

While I understand that there are times when backward compatibility cannot be maintained for the sake of progress, it would be nice if such breaking changes could be documented and better coordinated with its sistert project.

Many thanks!

delisma commented 3 years ago

Sorry @anthonyfok we will try to address this issue in the coming days. Can you tell me if and where you're using the canada-ca/canada-ca-jekyll-boilerplate? So that we will track the issue on a more general basis or even notify people not to update their site in the coming days.

anthonyfok commented 3 years ago

Hi @delisma!

I am a newcomer to the https://github.com/OpenDRR Project, and @jvanulde and I are exploring adding a new top-level organization GithHub Page at https://opendrr.github.io/ to link to our data and documentation pages (in separate repos), and so I conveniently used canada-ca/canada-ca-jekyll-boilerplate as template for testing on https://anthonyfok.github.io/ .

We (OpenDRR) are not currently using canada-ca/canada-ca-jekyll-boilerplate in production, so no worries, no harm was done at all, and the workaround to this issue is simple, i.e. by adding or adjusting the layout variable in the front matter of *.md files, as demonstrated in commit 22e354f in this wet-boew/gcweb-jekyll repo.

As I am new, I don't know which other GC departments are using this boilerplate, so I am only suspecting the latest changes could make existing production sites go blank, so I thought I'd better report it here. :-)

duboisp commented 3 years ago

You will need to specify the version into your config.yml file like:

remote_theme: wet-boew/gcweb-jekyll@v1.1.0

FYI - In the coming days, me and @delisma are going to work together and we will documents how to use the GCWeb jekyll. Within a few week, the GCWeb jekyll theme will be fully in sync with the latest change applied on GCWeb too.