Skip to content

Commit

Permalink
Create 5.2 branch
Browse files Browse the repository at this point in the history
  • Loading branch information
lcharette committed Mar 25, 2024
1 parent c1bc38b commit 606d14a
Show file tree
Hide file tree
Showing 4 changed files with 170 additions and 0 deletions.
48 changes: 48 additions & 0 deletions pages/22.upgrading/03.51-to-52/01.changelog/docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: What's new in 5.2
metadata:
description: A detailed look at what's new in UserFrosting 5.2
taxonomy:
category: docs
---

UserFrosting 5.2 focuses on... <!-- TODO -->

## Changed Requirements
UserFrosting 5.2... <!-- TODO -->

## Upgraded Dependencies
<!-- TODO -->

## Detailed changes
Changes generally applied across UserFrosting includes :
<!-- TODO -->

### UserFrosting Framework
<!-- TODO -->

### Core sprinkle
<!-- TODO -->

### Account sprinkle
<!-- TODO -->

### Admin Sprinkle
<!-- TODO -->

### AdminLTE theme
<!-- TODO -->

## Complete change Log

See the changelog of each component for the complete list of changes included in this release.
- [Skeleton](https://github.com/userfrosting/UserFrosting/blob/5.2/CHANGELOG.md#520)
- [Framework](https://github.com/userfrosting/framework/blob/5.2/CHANGELOG.md#520)
- [Core sprinkle](https://github.com/userfrosting/sprinkle-core/blob/5.2/CHANGELOG.md#520)
- [Account sprinkle](https://github.com/userfrosting/sprinkle-account/blob/5.2/CHANGELOG.md#520)
- [Admin sprinkle](https://github.com/userfrosting/sprinkle-admin/blob/5.2/CHANGELOG.md#520)
- [AdminLTE sprinkle](https://github.com/userfrosting/theme-adminlte/blob/5.2/CHANGELOG.md#520)

## Migrating

Now that we've cover the basics changes, follow on to the next pages to the steps required to bring your app up to date with UserFrosting 5.2.
82 changes: 82 additions & 0 deletions pages/22.upgrading/03.51-to-52/02.guide/docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
title: Upgrade Guide
metadata:
description: Upgrade guide from version 5.1.x to 5.2.x
taxonomy:
category: docs
---

## Dependencies
### Composer

Upgrading UserFrosting to `5.1.x` from `5.2.x` is as simple as updating your `composer.json` file and fetching updated dependencies! First, you'll need to edit your `composer.json`.

Update from :
```json
// ...
"require": {
"php": "^8.1",
"ext-gd": "*",
"userfrosting/framework": "~5.1.0",
"userfrosting/sprinkle-core": "~5.1.0",
"userfrosting/sprinkle-account": "~5.1.0",
"userfrosting/sprinkle-admin": "~5.1.0",
"userfrosting/theme-adminlte": "~5.1.0"
},
// ...
```

To:
```json
// ...
"require": {
"php": "^8.1",
"ext-gd": "*",
"userfrosting/framework": "~5.2.0",
"userfrosting/sprinkle-core": "~5.2.0",
"userfrosting/sprinkle-account": "~5.2.0",
"userfrosting/sprinkle-admin": "~5.2.0",
"userfrosting/theme-adminlte": "~5.2.0"
},
// ...
```

Now, simply use composer to get up to date with everything :

```bash
$ composer update
```

### NPM

Open `package.json` and update from :

```json
// ...
"dependencies": {
"@userfrosting/sprinkle-admin": "~5.1.0",
"@userfrosting/theme-adminlte": "~5.1.0"
},
// ...
```

To:
```json
// ...
"dependencies": {
"@userfrosting/sprinkle-admin": "~5.2.0",
"@userfrosting/theme-adminlte": "~5.2.0"
},
// ...
```

Now, simply use npm and [Bakery](/cli) to get up to date with everything else:

```bash
$ npm update
$ php bakery bake
```

## Migrating your Sprinkles

<!-- TODO -->
25 changes: 25 additions & 0 deletions pages/22.upgrading/03.51-to-52/03.roadmap/docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: Coming up next
metadata:
description:
taxonomy:
category: docs
---

### UserFrosting 5.3

The main focus of UserFrosting 5.3 will be :

- <!-- TODO -->
- Etc.

No release date has been determined right now. If you would like to give a hand, don't hesitate to contribute by sending a Pull Request on GitHub, or getting in touch on the [Chat](https://chat.userfrosting.com).

<!-- ### UserFrosting 6
Meanwhile, work for [UserFrosting 6](/upgrading/46-to-50/roadmap#userfrosting-6) is moving along! As a reminder, UF6 goal is to completely rewrite the frontend, with a brand new custom theme replacing AdminLTE and based on [UIKit](https://getuikit.com). Handlebar and every frontend javascript code will also be replaced with [Vue.js](https://vuejs.org).
You can find a proof of concept of this new Vue.js based UI (built with UF5) and the foundation of the new theme, **Pink Cupcake**, at the links below.
- [userfrosting/demo-vue](https://github.com/userfrosting/demo-vue/tree/main)
- [userfrosting/theme-pinkcupcake](https://github.com/userfrosting/theme-pinkcupcake) -->
15 changes: 15 additions & 0 deletions pages/22.upgrading/03.51-to-52/chapter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: 5.1.x to 5.2.x
metadata:
description: Upgrade guide for UserFrosting 5.2
taxonomy:
category: docs
---

# Upgrading to UserFrosting 5.2

Welcome, awesome developers, to the world of **UserFrosting 5.2**!

UserFrosting 5.2 focuses on... <!-- TODO -->

[notice]Before going further, make sure you're running the latest version of UserFrosting 5.1 and reviewed it's [upgrade guide](/upgrading/50-to-51).[/notice]

0 comments on commit 606d14a

Please sign in to comment.