describes migration requirements for 2.1.0

CDRH · Oct 18, 2018 · 3f44637 · 3f44637
1 parent ec4025a
commit 3f44637
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/lib/orchid/version.rb b/lib/orchid/version.rb
@@ -1,5 +1,5 @@
 module Orchid
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 
   def self.api_bridge_version
     'v0.0.3'

diff --git a/migration.md b/migration.md
@@ -1,5 +1,18 @@
 # Migration
 
+## 2.0.0 to 2.1.0
+
+This "minor" version changes configuration and addresses display bugs
+
+__config/public.yml__
+
+`title`, `subtitle`, and `shortname` have been moved to the locale files for language support. This is technically a breaking change for existing sites using 2.0.0 which relied on the default behavior for a single language to pull from the config instead of `locales/en.yml`, but as that is currently only one site, we are considering it a minor change.
+
+__assets__
+
+Recompile assets after updating to 2.1.0
+
+
 ## 1.1.1 to 2.0.0
 
 This major version introduces multiple language support.