Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a guide for Migrating to v1 #2518

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions docs/migrating-to-v1.md
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions spec/example_app/app/views/layouts/docs.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@

<ul class="sidebar-links">
<li><a href="/getting_started">Getting Started</a></li>
<li><a href="/migrating-to-v1">Migrating to v1</a></li>
<li><a href="/customizing_dashboards">Customizing Dashboards</a></li>
<li><a href="/customizing_page_views">Customizing Page Views</a></li>
<li><a href="/customizing_attribute_partials">Customizing Attribute Partials</a></li>
Expand Down
Loading