Difference between revisions of "Updating: to 2.0.0"

From Lorekeeper Wiki
Jump to navigation Jump to search
Line 3: Line 3:
 
==New in v2==
 
==New in v2==
  
=== Extensions and features from <u>modified-main</u> ===
+
===Extensions and features from <u>modified-main</u>===
 
<u>modified-main</u> was a branch incorporating several community-developed [[:Category:Extensions|Extensions]] selected for their wide applicability and for falling into one of the following categories:
 
<u>modified-main</u> was a branch incorporating several community-developed [[:Category:Extensions|Extensions]] selected for their wide applicability and for falling into one of the following categories:
  
* An unavoidable change in behavior, but one that is arguably a net quality-of-life improvement. May also be highly useful as a base for other extensions to build upon.
+
*An unavoidable change in behavior, but one that is arguably a net quality-of-life improvement. May also be highly useful as a base for other extensions to build upon.
* Opt-in/must be deliberately enabled for significant changes in the behavior of the site to occur. No more obtrusive than effectively optional functions in core Lorekeeper if not in use.
+
*Opt-in/must be deliberately enabled for significant changes in the behavior of the site to occur. No more obtrusive than effectively optional functions in core Lorekeeper if not in use.
  
 
It includes certain extensions on an opt-in basis via a config file; these extensions tend to be sufficiently contained for this to be a viable option.
 
It includes certain extensions on an opt-in basis via a config file; these extensions tend to be sufficiently contained for this to be a viable option.
Line 13: Line 13:
 
Also included are several minor but useful features:
 
Also included are several minor but useful features:
  
* '''Grouped Notifications:''' To account for the potentially large variety and potentially volume of notifications, they are grouped by notification type and collapse when there are more than 5 notifications of a type.
+
*'''Grouped Notifications:''' To account for the potentially large variety and potentially volume of notifications, they are grouped by notification type and collapse when there are more than 5 notifications of a type.
* '''Toggleable Comments on Site Pages:''' Adds a toggle to site pages which enables/disables commenting on them. Disabled by default.
+
*'''Toggleable Comments on Site Pages:''' Adds a toggle to site pages which enables/disables commenting on them. Disabled by default.
* '''Extension Service:''' A utility for use by extension developers. By default, facilitates adjusting notification type IDs in a site's DB to comply with the [[Community Notification Standard]]. See the [https://github.com/itinerare/lorekeeper/blob/15f9ba0a750f4a08d1e3e07139ad32a0b3c7fc9f/app/Console/Commands/FixCharItemNotifs.php this command] (made for Character Items) for an example of how to use this functionality.
+
*'''Extension Service:''' A utility for use by extension developers. By default, facilitates adjusting notification type IDs in a site's DB to comply with the [[Community Notification Standard]]. See the [https://github.com/itinerare/lorekeeper/blob/15f9ba0a750f4a08d1e3e07139ad32a0b3c7fc9f/app/Console/Commands/FixCharItemNotifs.php this command] (made for Character Items) for an example of how to use this functionality.
  
==== Included Extensions ====
+
This branch and its contents have been integrated into core as of this release, as they present strong improvements to the functionality of Lorekeeper.
 +
 
 +
====Included Extensions====
 
Documentation (where it exists) for these extensions can be viewed via [[:Category:Extensions in modified-main|Category: Extensions in modified-main]].
 
Documentation (where it exists) for these extensions can be viewed via [[:Category:Extensions in modified-main|Category: Extensions in modified-main]].
  
* [https://github.com/Draginraptor Draginraptor] : [[Extensions:Stacked Inventories]]
+
*[https://github.com/Draginraptor Draginraptor] : [[Extensions:Stacked Inventories]]
* [https://github.com/itinerare itinerare] : [[Extensions:Submission Addons]]
+
*[https://github.com/itinerare itinerare] : [[Extensions:Submission Addons]]
* [https://github.com/itinerare itinerare] : [[Extensions:Character Items]]
+
*[https://github.com/itinerare itinerare] : [[Extensions:Character Items]]
* [https://github.com/preimpression Preimpression] : [[Extensions:Bootstrap Tables]]
+
*[https://github.com/preimpression Preimpression] : [[Extensions:Bootstrap Tables]]
* [https://github.com/itinerare itinerare] : [[Extensions:Watermarking]]
+
*[https://github.com/itinerare itinerare] : [[Extensions:Watermarking]]
* [https://github.com/itinerare itinerare] : [[Extensions:Separate Prompts]]
+
*[https://github.com/itinerare itinerare] : [[Extensions:Separate Prompts]]
* [https://github.com/preimpression Preimpression] & [https://github.com/Ne-wt Ne-wt] : [[Extensions:Comments]]
+
*[https://github.com/preimpression Preimpression] & [https://github.com/Ne-wt Ne-wt] : [[Extensions:Comments]]
* [https://github.com/Ne-wt Ne-wt] : Reports System : Adds the ability for users to submit general and bug reports, as well as providing a visible list of current, non-sensitive (exploit) bugs.
+
*[https://github.com/Ne-wt Ne-wt] : Reports System : Adds the ability for users to submit general and bug reports, as well as providing a visible list of current, non-sensitive (exploit) bugs.
* [https://github.com/junijwi Junijwi] : [[Extensions:Masterlist Sublists]]
+
*[https://github.com/junijwi Junijwi] : [[Extensions:Masterlist Sublists]]
* [https://github.com/junijwi Junijwi] : [[Extensions:MYO Item Tag]]
+
*[https://github.com/junijwi Junijwi] : [[Extensions:MYO Item Tag]]
 +
 
 +
=====Opt-In Extensions=====
  
===== Opt-In Extensions =====
+
*[https://github.com/junijwi Junijwi] : [[Extensions:Navbar News Notif|Navbar News Notif]] - Has also been modified to apply to sales
 +
*[https://github.com/itinerare itinerare] : [[Extensions:Species Trait Index|Species Trait Index]]
 +
*[https://github.com/junijwi Junijwi] : [[Extensions:Character Status Badges|Character Status Badges]]
 +
*[https://github.com/junijwi Junijwi] : [[Extensions:Character TH Profile Link|Character TH Profile Link]]
 +
*[https://github.com/itinerare itinerare] : [[Extensions:Design Update Voting|Design Update Voting]]
 +
*[https://github.com/itinerare itinerare] : [[Extensions:Item Entry Expansion|Item Entry Expansion (Stacked Inventories version)]]
  
* [https://github.com/junijwi Junijwi] : [[Extensions:Navbar News Notif|Navbar News Notif]] - Has also been modified to apply to sales
+
=== Galleries ===
* [https://github.com/itinerare itinerare] : [[Extensions:Species Trait Index|Species Trait Index]]
+
The [[Extensions:Galleries|Galleries]] extension has been integrated, providing Lorekeeper sites with the means to set up their own built-in galleries for user submissions of art and literature.
* [https://github.com/junijwi Junijwi] : [[Extensions:Character Status Badges|Character Status Badges]]
 
* [https://github.com/junijwi Junijwi] : [[Extensions:Character TH Profile Link|Character TH Profile Link]]
 
* [https://github.com/itinerare itinerare] : [[Extensions:Design Update Voting|Design Update Voting]]
 
* [https://github.com/itinerare itinerare] : [[Extensions:Item Entry Expansion|Item Entry Expansion (Stacked Inventories version)]]
 
  
 
==Updating to v2==
 
==Updating to v2==

Revision as of 10:01, 19 May 2021

Version 2 of Lorekeeper brings several new features and improvements, including the integration of the previous modified-main branch and its extensions, the integration of Extensions:Galleries, and the expansion of social media sites available for user authentication. On a technical level, this includes updating Lorekeeper to Laravel 8 (from version 1.x's 5.8); while the impact of this is relatively limited, it has some minor impacts in what methods are used for some tasks.

New in v2

Extensions and features from modified-main

modified-main was a branch incorporating several community-developed Extensions selected for their wide applicability and for falling into one of the following categories:

  • An unavoidable change in behavior, but one that is arguably a net quality-of-life improvement. May also be highly useful as a base for other extensions to build upon.
  • Opt-in/must be deliberately enabled for significant changes in the behavior of the site to occur. No more obtrusive than effectively optional functions in core Lorekeeper if not in use.

It includes certain extensions on an opt-in basis via a config file; these extensions tend to be sufficiently contained for this to be a viable option.

Also included are several minor but useful features:

  • Grouped Notifications: To account for the potentially large variety and potentially volume of notifications, they are grouped by notification type and collapse when there are more than 5 notifications of a type.
  • Toggleable Comments on Site Pages: Adds a toggle to site pages which enables/disables commenting on them. Disabled by default.
  • Extension Service: A utility for use by extension developers. By default, facilitates adjusting notification type IDs in a site's DB to comply with the Community Notification Standard. See the this command (made for Character Items) for an example of how to use this functionality.

This branch and its contents have been integrated into core as of this release, as they present strong improvements to the functionality of Lorekeeper.

Included Extensions

Documentation (where it exists) for these extensions can be viewed via Category: Extensions in modified-main.

Opt-In Extensions

Galleries

The Galleries extension has been integrated, providing Lorekeeper sites with the means to set up their own built-in galleries for user submissions of art and literature.

Updating to v2

As of v2, Lorekeeper now requires php 7.4 (previously was 7.2). No other requirements are changed.

Summary

  • Update your server to use php 7.4
  • Pull the updates, resolving any merge conflicts as appropriate
  • Make any config file changes
  • (Recommended) Put your site in maintenance mode via php artisan down
  • Push updates
  • Run composer update or equivalent and then php artisan update-lorekeeper-v2
  • (Recommended) Verify that no errors have occurred and use php artisan up to remove your site from maintenance mode
  • Perform any configuration desired within the site