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

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

Open
anthonyfok opened this issue Feb 17, 2021 · 3 comments · May be fixed by #28
Open

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

anthonyfok opened this issue Feb 17, 2021 · 3 comments · May be fixed by #28
Assignees
Labels
bug Something isn't working

Comments

@anthonyfok
Copy link

@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!

@anthonyfok anthonyfok changed the title Latest renaming/removal of layouts introduce breaking changes that needs documentation Latest renaming/removal of layouts introduce breaking changes that should be documented Feb 17, 2021
@delisma
Copy link

delisma commented Feb 17, 2021

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
Copy link
Author

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
Copy link
Member

duboisp commented Feb 17, 2021

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

remote_theme: wet-boew/[email protected]

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants