steffen/website
1
0
Fork 0
Code Actions Packages Releases Activity

Update docs

Browse Source
This commit is contained in:
Michael Rose
2016-04-13 22:38:28 -04:00
parent f3d2421b4e
commit 140674ac9a
17 changed files with 168 additions and 110 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
_docs/04-upgrading.md
View File

@@ -14,7 +14,7 @@ Currently there is no good way of upgrading the theme without doing a bit of man
## Use Git
If you want to get the most out of the Jekyll + GitHub Pages workflow, then you'll need to utilize Git. To pull down theme updates you must first ensure there's an upstream remote. If you forked the Minimal Mistakes repo then you're likely good to go.
If you want to get the most out of the Jekyll + GitHub Pages workflow, then you'll need to utilize Git. To pull down theme updates you must first ensure there's an upstream remote. If you forked the theme's repo then you're likely good to go.
To double check, run `git remote -v` and verify that you can fetch from `origin {{ site.gh_repo }}/minimal-mistakes.git`.
@@ -26,23 +26,25 @@ $ git remote add upstream {{ site.gh_repo }}/minimal-mistakes.git
### Pull Down Updates
Now you can pull any commits made to Minimal Mistakes `master` branch with:
Now you can pull any commits made to theme's `master` branch with:
```bash
$ git pull upstream master
```
Depending on the amount of customizations you've made after forking, there's likely to be merge conflicts. Work through the files Git lists as having conflicts and you should be all set.
Depending on the amount of customizations you've made after forking, there's likely to be merge conflicts. Work through any conflicting files Git flags, stagging the changes you wish to keep, and then commit them.
## Update Files Manually
The alternate way of dealing with updates is [downloading the theme]({{ site.gh_repo }}/archive/master.zip) --- replacing your layouts, includes, and assets with the newer ones. To be sure that you don't miss any changes it's probably a good idea to review the [history]({{ site.gh_repo }}/commits/master) to see what's changed since you last forked/cloned the theme.
Another way of dealing with updates is [downloading the theme]({{ site.gh_repo }}/archive/master.zip) --- replacing your layouts, includes, and assets with the newer ones manually. To be sure that you don't miss any changes it's probably a good idea to review the theme's [commit history]({{ site.gh_repo }}/commits/master) to see what's changed since.
Here's a quick checklist of the important folders/files you'll want to be mindful of:
* `_layouts`
* `_includes`
* `assets` --- if you customized the stylesheets or added your own scripts make sure you reapply those changes
* `_data\navigation.yml` --- you likely edited this so double check that there were no major structural changes
* `_data\ui-text.yml` --- same as above
* `_config.yml` --- same as above
| Name | |
| ---- | --- |
| `_layouts` | Replace all. Apply edits if you customized any layouts. |
| `_includes` | Replace all. Apply edits if you customized any includes. |
| `assets` | Replace all. Apply edits if you customized stylesheets or scripts. |
| `_data/navigation.yml` | Safe to keep. Verify that there were no major structural changes or additions. |
| `_data/ui-text.yml` | Safe to keep. Verify that there were no major structural changes or additions. |
| `_config.yml` | Safe to keep. Verify that there were no major structural changes or additions. |