diff --git a/docs/migrating-to-v1.md b/docs/migrating-to-v1.md new file mode 100644 index 0000000000..f3d182bd45 --- /dev/null +++ b/docs/migrating-to-v1.md @@ -0,0 +1,34 @@ +--- +title: Migrating to v1 +--- + +In the release of v1.0.0, we [began bundling assets in the gem itself][2397]. +In future, this should mean that changes to the way you, or Administrate +manages assets should not have an effect on you. However, this is quite a big +change and so you might find some problems. + +As with most upgrades, if you're upgrading between versions with changes to the +templates, and if you've customised them, you may need to apply recent changes. +You can see those which changed in the [CHANGELOG][]. + +This applies to both modified files in `app/views/admin` and `app/views/fields` +if you have your own Field classes defined. A good way is to use the same command +to generate the view as for the earlier version: +`rails generate administrate:views:ACTION MyModel` +noting the changes and re-applying the modifications + +[2397]: https://github.com/thoughtbot/administrate/pull/2397 +[CHANGELOG]: https://github.com/thoughtbot/administrate/blob/main/CHANGELOG.md + +## Reported Issues + +### Removal of the `sprockets-rails` transitive dependency + +[Issue][2514] + +Previously, Administrate depended on [`sprockets-rails`][], if you have a +dependency which requires this, you may now need to add a direct dependency on +your application. + +[2514]: https://github.com/thoughtbot/administrate/issues/2514 +[`sprockets-rails`]: https://rubygems.org/gems/sprockets-rails diff --git a/spec/example_app/app/views/layouts/docs.html.erb b/spec/example_app/app/views/layouts/docs.html.erb index 27c3d1f2b6..bd02d773bf 100644 --- a/spec/example_app/app/views/layouts/docs.html.erb +++ b/spec/example_app/app/views/layouts/docs.html.erb @@ -25,6 +25,7 @@