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.

Sign up for GitHub

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 UPGRADE.md and updated upgrade docs #45

Merged
merged 1 commit into from
Sep 9, 2024
Merged

Add UPGRADE.md and updated upgrade docs #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 23 additions & 0 deletions UPGRADE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Upgrading from v1 to v2

LmcAdmin v2 is a major version upgrade with many breaking changes that prevent
straightforward upgrading.

### Namespace change

The namespace has been changed from LmcAdmin to Lmc\Admin.

Please review your code to replace references to the `LmcAdmin` namespace
by the `Lmc\Admin` namespace.

### Default layout template name

The default layout template has been changed from `layout/admin` to `layout/lmcadmin`.

The `index` action of the `AdminController` now returns a View Model with its template set to
`'lmc-admin/admin/index'`. To use your customer view template, you need to add a View Manager
template map entry for `'lmc-admin/admin/index'` that points to your custom view.

### Configuration key

The configuration key for LmcAdmin was changed from `lmcadmin` to `lmc_admin`.
6 changes: 5 additions & 1 deletion docs/docs/Upgrading/to-v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@ by the `Lmc\Admin` namespace.

### Default layout template name

The default layout template has been changed from `layout/admin` to `layout/lmcadmin`.
The default layout template has been changed from `layout/admin` to `layout/lmcadmin`

The `index` action of the `AdminController` now returns a View Model with its template set to
`'lmc-admin/admin/index'`. To use your customer view template, you need to add a View Manager
template map entry for `'lmc-admin/admin/index'` that points to your custom view.

### Configuration key

Expand Down
4 changes: 4 additions & 0 deletions docs/versioned_docs/version-2.0/Upgrading/to-v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ by the `Lmc\Admin` namespace.

The default layout template has been changed from `layout/admin` to `layout/lmcadmin`.

The `index` action of the `AdminController` now returns a View Model with its template set to
`'lmc-admin/admin/index'`. To use your customer view template, you need to add a View Manager
template map entry for `'lmc-admin/admin/index'` that points to your custom view.

### Configuration key

The configuration key for LmcAdmin was changed from `lmcadmin` to `lmc_admin`.