wet-boew / GCWeb

Canada.ca theme - A reference implementation of the Canada.ca Content and Information Architecture Specification, the Canada.ca Content Style Guide and the Canada.ca Design System
https://wet-boew.github.io/GCWeb/
Other
93 stars 130 forks source link

Bug - theming assets links broken (404) #1792

Open nfee006 opened 3 years ago

nfee006 commented 3 years ago

Describe the bug

Multiple theming elements referenced in the static-header-footer are unavailable (404) as of approximately 16h EST on 10/03/2021. Files affected:

To Reproduce

Steps to reproduce the behavior:

  1. Go to https://github.com/wet-boew/GCWeb/blob/db8f99ce9d1f8f58a58771269fa18d0b5c995a8a/site/pages/gcweb-theme/static-header-footer/bootstrap-3.html
  2. Locate the links for the files mentioned above.
  3. Notice the 404 status message when you navigate to them.

Alternatively,

  1. Access a site that makes use of the Bootstraps 3 header/footer. I am not aware of any ones that are widely available though.

Example

The site in question is only available on my agency's intranet. As such, I cannot provide a useable link.

image

Current behavior

Theming elements are not accessible. The most notable issue is that, without the CSS, the theme menu is unstyled and takes up most of the page.

Expected behavior

The expected behaviour would be that the theming elements load (unless there has been a major update that I am not aware of?).

Screenshots and/or logs

If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

Smartphone (please complete the following information):

Additional context

I am not a web developer and am very open to other solutions if they exist. I do have the GCWeb theme downloaded locally but it's not clear if that's the best solution.

RobJohnston commented 3 years ago

Linking for posterity: https://github.com/wet-boew/wet-boew/issues/9060

anthonyfok commented 3 years ago

We have some live Internet examples showing the breakage due to GCWeb theme assets links now 404 (though we will be fixing our websites with local assets later today):

Please keep backward compatibility in mind, preferably as the topmost priority, whenever you change things, like how popular dependencies like jQuery and Bootstrap keep all of their new and old versions on CDN for posterity so as not to break websites.

Another thing I would highly suggest is to have end users host the GCWeb assets on their own servers instead of relying on https://wet-boew.github.io/themes-dist/GCWeb/, which, in this case, becomes a single point of failure. Maybe this is already being implemented in your new restructuring, but if not, please consider this and other ways to make GCWeb more resilient and immune to such 404 breakage.

Many thanks!

Related issue: https://github.com/wet-boew/gcweb-jekyll/issues/21

anthonyfok commented 3 years ago

In retrospect, perhaps the root issue lies with assumptions made in gcweb-jekyll? See wet-boew/gcweb-jekyll#23

duboisp commented 3 years ago

I confirm this broken link was introduced when we have made recent changes to our continuous deployment script from travis-ci to github action, in the preparation of the GCWeb release v9.2.0.

An immediate and permanent solution will be to add the missing folder name "GCWeb" for the base URL. Example:

Those URL / files locations are not in scope of our Public API according to : https://wet-boew.github.io/wet-boew-documentation/decision/3.html

I will fix the broken link into the source file: /site/pages/gcweb-theme/static-header-footer/bootstrap-3.html along with the PR: https://github.com/wet-boew/GCWeb/pull/1784

You are free to submit a PR that will re-introduce those folder into the GCWeb "dist" by updating the continuous deployment script here: https://github.com/wet-boew/GCWeb/blob/master/.github/workflows/cd.yml