From 606d14a0e28e4d1f062b893c440e4ec2bb1346fa Mon Sep 17 00:00:00 2001 From: Louis Charette Date: Mon, 25 Mar 2024 19:38:59 -0400 Subject: [PATCH 1/3] Create 5.2 branch --- .../03.51-to-52/01.changelog/docs.md | 48 +++++++++++ .../22.upgrading/03.51-to-52/02.guide/docs.md | 82 +++++++++++++++++++ .../03.51-to-52/03.roadmap/docs.md | 25 ++++++ pages/22.upgrading/03.51-to-52/chapter.md | 15 ++++ 4 files changed, 170 insertions(+) create mode 100644 pages/22.upgrading/03.51-to-52/01.changelog/docs.md create mode 100644 pages/22.upgrading/03.51-to-52/02.guide/docs.md create mode 100644 pages/22.upgrading/03.51-to-52/03.roadmap/docs.md create mode 100644 pages/22.upgrading/03.51-to-52/chapter.md diff --git a/pages/22.upgrading/03.51-to-52/01.changelog/docs.md b/pages/22.upgrading/03.51-to-52/01.changelog/docs.md new file mode 100644 index 00000000..606da900 --- /dev/null +++ b/pages/22.upgrading/03.51-to-52/01.changelog/docs.md @@ -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... + +## Changed Requirements +UserFrosting 5.2... + +## Upgraded Dependencies + + +## Detailed changes +Changes generally applied across UserFrosting includes : + + +### UserFrosting Framework + + +### Core sprinkle + + +### Account sprinkle + + +### Admin Sprinkle + + +### AdminLTE theme + + +## 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. diff --git a/pages/22.upgrading/03.51-to-52/02.guide/docs.md b/pages/22.upgrading/03.51-to-52/02.guide/docs.md new file mode 100644 index 00000000..8bfe8fbb --- /dev/null +++ b/pages/22.upgrading/03.51-to-52/02.guide/docs.md @@ -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 + + diff --git a/pages/22.upgrading/03.51-to-52/03.roadmap/docs.md b/pages/22.upgrading/03.51-to-52/03.roadmap/docs.md new file mode 100644 index 00000000..a2a22b4b --- /dev/null +++ b/pages/22.upgrading/03.51-to-52/03.roadmap/docs.md @@ -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 : + +- +- 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). + + diff --git a/pages/22.upgrading/03.51-to-52/chapter.md b/pages/22.upgrading/03.51-to-52/chapter.md new file mode 100644 index 00000000..ca5b1a6c --- /dev/null +++ b/pages/22.upgrading/03.51-to-52/chapter.md @@ -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... + +[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] \ No newline at end of file From 967b043da0066780d6f3c4b9dcb25e4b7c1098f1 Mon Sep 17 00:00:00 2001 From: StrykeSlammerII Date: Mon, 28 Oct 2024 02:57:14 -0400 Subject: [PATCH 2/3] Additional usage notes (and working code sample) for `addParams` Solves https://github.com/userfrosting/UserFrosting/issues/1275 --- .../04.components/02.tables/docs.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/pages/15.client-side-code/04.components/02.tables/docs.md b/pages/15.client-side-code/04.components/02.tables/docs.md index e8b06933..cfd16023 100644 --- a/pages/15.client-side-code/04.components/02.tables/docs.md +++ b/pages/15.client-side-code/04.components/02.tables/docs.md @@ -348,6 +348,19 @@ An object containing tablesorter's [configuration options](https://mottie.github An object containing any additional key-value pairs that you want appended to the AJAX requests made by the table. Useful when implementing, for example, site-wide filters or using data sources that require additional context. +When sending an AJAX request to a Sprunje, there are some hoops to jump through: +1. Remember that sprunjes only accept [certain parameters](/database/data-sprunjing#sprunje-parameters). If, for instance, you want to filter by "UserID" that's set outside of the table, you'll need to pass `filters[UserID]` in the AJAX request rather than simply `UserID`. +2. Additionally, sprunjes only accept [whitelisted fields](/database/data-sprunjing#sorts-and-filters), so you'll need to ensure that `UserID` is in the appropriate array in the sprunje--in this case, `$filterable`. +3. Optional: Unless you're hardcoding the parameter value, you may need to [export it to JS](/client-side-code/exporting-variables). + +In this Javascript sample, we've already asked the user for a Genus name and exported it to the variable `page.owl.genus`. +```javascript +$("#myUserTable").ufTable({ + dataUrl: site.uri.public + "/api/owls", + addParams: {"filters[species]" : page.owl.genus} +}); +``` + ### filterAllField The special filter name that should be sent in AJAX requests when a global search (as opposed to column-specific searches) is performed. Defaults to `_all`. From 57062ed9d3d6ddb58ab75e13c5fc4f60130c6e47 Mon Sep 17 00:00:00 2001 From: Louis Charette Date: Mon, 28 Oct 2024 19:35:24 -0400 Subject: [PATCH 3/3] Remove 5.2 reference --- .../03.51-to-52/01.changelog/docs.md | 48 ----------- .../22.upgrading/03.51-to-52/02.guide/docs.md | 82 ------------------- .../03.51-to-52/03.roadmap/docs.md | 25 ------ pages/22.upgrading/03.51-to-52/chapter.md | 15 ---- 4 files changed, 170 deletions(-) delete mode 100644 pages/22.upgrading/03.51-to-52/01.changelog/docs.md delete mode 100644 pages/22.upgrading/03.51-to-52/02.guide/docs.md delete mode 100644 pages/22.upgrading/03.51-to-52/03.roadmap/docs.md delete mode 100644 pages/22.upgrading/03.51-to-52/chapter.md diff --git a/pages/22.upgrading/03.51-to-52/01.changelog/docs.md b/pages/22.upgrading/03.51-to-52/01.changelog/docs.md deleted file mode 100644 index 606da900..00000000 --- a/pages/22.upgrading/03.51-to-52/01.changelog/docs.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -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... - -## Changed Requirements -UserFrosting 5.2... - -## Upgraded Dependencies - - -## Detailed changes -Changes generally applied across UserFrosting includes : - - -### UserFrosting Framework - - -### Core sprinkle - - -### Account sprinkle - - -### Admin Sprinkle - - -### AdminLTE theme - - -## 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. diff --git a/pages/22.upgrading/03.51-to-52/02.guide/docs.md b/pages/22.upgrading/03.51-to-52/02.guide/docs.md deleted file mode 100644 index 8bfe8fbb..00000000 --- a/pages/22.upgrading/03.51-to-52/02.guide/docs.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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 - - diff --git a/pages/22.upgrading/03.51-to-52/03.roadmap/docs.md b/pages/22.upgrading/03.51-to-52/03.roadmap/docs.md deleted file mode 100644 index a2a22b4b..00000000 --- a/pages/22.upgrading/03.51-to-52/03.roadmap/docs.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Coming up next -metadata: - description: -taxonomy: - category: docs ---- - -### UserFrosting 5.3 - -The main focus of UserFrosting 5.3 will be : - -- -- 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). - - diff --git a/pages/22.upgrading/03.51-to-52/chapter.md b/pages/22.upgrading/03.51-to-52/chapter.md deleted file mode 100644 index ca5b1a6c..00000000 --- a/pages/22.upgrading/03.51-to-52/chapter.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -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... - -[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] \ No newline at end of file