Difference between revisions of "Extensions:Staff Team Page"

From Lorekeeper Wiki
Jump to navigation Jump to search
(Created page with "{{subst:Extension Page}}")
Tag: 2017 source edit
 
(Create Extensions:Staff Team Page)
Tag: 2017 source edit
Line 1: Line 1:
{{Extensioninfobox|title=the extension's name|desc=A short description|auth=Author(s)|status=status (such as WIP, testing, stable)|github={{Github|user=username|branch=branch}}|LKVer=What Lorekeeper version the ext is built on|migration=yes/no|package=yes/no}}
+
{{Extensioninfobox|title=Steaff Team Page|desc=Creates a team page with all staff members.|auth=AnimatedCritter|status=stable|github={{Github|user=AnimatedCritter|branch=extension/staff-team-page}}|LKVer=2.1.0|migration=yes|package=no}}
<!-- Put a short summary of your extension here! -->
+
This extension creates a team page that displays all members of a website's staff. This includes the addition of staff profiles, which are small segments of text and  collection of contact links staff members can customize.
 
== Installation ==
 
== Installation ==
<!-- Describe installation. Include any requirements (such as packages), necessary commands, etc. -->
+
Pull and merge the branch, making sure to address any merge issues.
 +
 
 +
Afterwards, run the following commands in your console:
 +
 
 +
<code>php artisan migrate</code>
 +
 
 +
<code>php artisan update-extension-tracker</code>
 
== Configuration ==
 
== Configuration ==
<!-- Is any configuration necessary? Describe it here! -->
+
By default, the admin account and all users with ranks possessing staff permissions will display on the team page. To adjust what users are visible on the team page, please see your <code>app\Http\Controllers</code>, under the <code>getTeamIndex()</code> function.
== Usage ==
+
 
<!-- Is there anything users should know about using your extension? -->
+
'''To hard-code a non-staff role''' (such as you site’s Guest Artist role), add a comma and the ID of the desired role.
 +
 
 +
* Example: $staffRanks->push(Settings::get('admin_user'), 3, 5);
 +
 
 +
* Be careful '''NOT''' to include ranks with tons of users (such as regular members), as there is no pagination.
 +
 
 +
* Notice that users with non-staff roles cannot update their staff profiles, so a user with a staff role will have to update it for them via the user index (/admin/users).
 +
 
 +
'''To remove the admin account''' from the listing, delete <code>Settings::get('admin_user')</code> from <code>$staffRanks->push()</code>.
 +
 
 +
 
 
== Troubleshooting ==
 
== Troubleshooting ==
<!-- Are there known issues or errors that require user action? Who should they contact, and where, for support? -->
+
If you are having any issues (or have suggestions to improve this extension) you can find me over on the Lorekeeper Discord server (AnimatedCritter#7094)!
 
== Images ==
 
== Images ==
<!-- Do you have any images to show what it looks like in action? -->
+
[[File:Screenshot 2023-04-30 215157|none|thumb]]
== See Also ==
 
<!-- Any relevant other pages. You may consider linking to related extensions, for instance. -->
 
 
 

Revision as of 20:08, 30 April 2023

Steaff Team Page
Description Creates a team page with all staff members.
Author(s) AnimatedCritter
Status stable
Github extension/staff-team-page
LK Version 2.1.0
Contains a Migration






This extension creates a team page that displays all members of a website's staff. This includes the addition of staff profiles, which are small segments of text and collection of contact links staff members can customize.

Installation

Pull and merge the branch, making sure to address any merge issues.

Afterwards, run the following commands in your console:

php artisan migrate

php artisan update-extension-tracker

Configuration

By default, the admin account and all users with ranks possessing staff permissions will display on the team page. To adjust what users are visible on the team page, please see your app\Http\Controllers, under the getTeamIndex() function.

To hard-code a non-staff role (such as you site’s Guest Artist role), add a comma and the ID of the desired role.

  • Example: $staffRanks->push(Settings::get('admin_user'), 3, 5);
  • Be careful NOT to include ranks with tons of users (such as regular members), as there is no pagination.
  • Notice that users with non-staff roles cannot update their staff profiles, so a user with a staff role will have to update it for them via the user index (/admin/users).

To remove the admin account from the listing, delete Settings::get('admin_user') from $staffRanks->push().


Troubleshooting

If you are having any issues (or have suggestions to improve this extension) you can find me over on the Lorekeeper Discord server (AnimatedCritter#7094)!

Images