18F / uswds-jekyll

A Jekyll theme showcasing the U.S. Web Design System

Home Page:https://federalist-proxy.app.cloud.gov/site/18f/uswds-jekyll/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

add tips on how to not upgrade

afeld opened this issue · comments

A user (friend of the show, thankfully) pointed out that their site unexpectedly broke when using uswds-jekyll as a remote theme. Let's include a section in the migration guide about how to lock to a previous version, whether someone is using a Gemfile or a remote theme.

While we're at it, let's add a message at the top of the README about "5.0 was released with breaking changes—see the migration guide."

Acceptance criteria

  • There are clear instructions about how to avoid using the latest versions of the theme

@afeld should this stay on our board? If so, are we the owners of this repo? Otherwise, I would maybe transfer this to our repo unless it needs to stay in this repo

are we the owners of this repo?

18F/tts-tech-portfolio#699

Closing as stale.