From 6112dba29e82690b27e359d8c39d7c786db30310 Mon Sep 17 00:00:00 2001 From: Michael Rose Date: Thu, 21 Sep 2017 16:19:24 -0400 Subject: [PATCH] Clarify theme gem migration documentation Include asset folders that should be removed when migrating from a "forked theme". Close #1268 --- CHANGELOG.md | 1 + docs/_docs/01-quick-start-guide.md | 7 ++++--- docs/_docs/18-history.md | 3 ++- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0bab4380..496b9ea1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ ### Enhancements - Add `alt` description to avatar image. [#1226](https://github.com/mmistakes/minimal-mistakes/pull/1226) +- Clarify documentation about which `assets` folders and files to remove when migrating to the gem version of the theme. [#1268](https://github.com/mmistakes/minimal-mistakes/issues/1268) ## [4.6.0](https://github.com/mmistakes/minimal-mistakes/releases/tag/4.6.0) diff --git a/docs/_docs/01-quick-start-guide.md b/docs/_docs/01-quick-start-guide.md index 1b4ac424..e0123103 100644 --- a/docs/_docs/01-quick-start-guide.md +++ b/docs/_docs/01-quick-start-guide.md @@ -2,7 +2,7 @@ title: "Quick-Start Guide" permalink: /docs/quick-start-guide/ excerpt: "How to quickly install and setup Minimal Mistakes for use with GitHub Pages." -last_modified_at: 2017-09-01T09:27:53-04:00 +last_modified_at: 2017-09-21T16:16:40-04:00 redirect_from: - /theme-setup/ --- @@ -130,9 +130,10 @@ Edit `_config.yml`. Then: If you're migrating a site already using Minimal Mistakes and haven't customized any of the theme files things upgrading will be easier for you. -Start by removing `_includes`, `_layouts`, `_sass`, `assets` folders and all files within. +Start by removing the following folders: `_includes`, `_layouts`, `_sass`, `assets/css`, `assets/fonts`, `assets/js` and the files within. You won't need these anymore as they're bundled with the theme gem --- unless you intend to [override them](http://jekyllrb.com/docs/themes/#overriding-theme-defaults). -You won't need these anymore as they're bundled with the theme gem. +**Note:** When clearing out the `assets` folder be sure to leave any files you've added. This includes images, CSS, or JavaScript that aren't already [bundled in the theme](https://github.com/mmistakes/minimal-mistakes/tree/master/assets). +{: .notice--warning} From `v4.5.0` onwards, you don't have to maintain a copy of the default data files viz. `_data/ui-text.yml` and `_data/navigation.yml` either. The default files are read-in automatically via the [`jekyll-data`](https://github.com/ashmaroli/jekyll-data) plugin. diff --git a/docs/_docs/18-history.md b/docs/_docs/18-history.md index a1b3f9fb..e7533815 100644 --- a/docs/_docs/18-history.md +++ b/docs/_docs/18-history.md @@ -4,7 +4,7 @@ permalink: /docs/history/ excerpt: "Change log of enhancements and bug fixes made to the theme." sidebar: nav: docs -last_modified_at: 2017-09-20T15:58:39-04:00 +last_modified_at: 2017-09-21T16:17:50-04:00 --- ## Unreleased @@ -12,6 +12,7 @@ last_modified_at: 2017-09-20T15:58:39-04:00 ### Enhancements - Add `alt` description to avatar image. [#1226](https://github.com/mmistakes/minimal-mistakes/pull/1226) +- Clarify documentation about which `assets` folders and files to remove when migrating to the gem version of the theme. [#1268](https://github.com/mmistakes/minimal-mistakes/issues/1268) ## [4.6.0](https://github.com/mmistakes/minimal-mistakes/releases/tag/4.6.0)