Tutorial: Installing Extensions - Revision history

Ellanoire: /* 7. Push to Site */

2022-01-26T19:53:57Z

7. Push to Site

Ellanoire: /* Merging Conflicts */

2022-01-26T19:50:30Z

Merging Conflicts

Ellanoire: Clarifying what installing one extension at a time means.

2022-01-26T19:48:33Z

Clarifying what installing one extension at a time means.

Ellanoire: /* 6. Testing */

2022-01-26T18:15:45Z

6. Testing

Ellanoire: Update installation instructions to include local testing.

2022-01-26T18:14:33Z

Update installation instructions to include local testing.

Mercury: /* Reversing an Entire Extension Installation */

2021-07-08T20:33:31Z

Reversing an Entire Extension Installation

Mercury: /* Reversing an Entire Extension Installation */

2021-07-08T20:32:15Z

Reversing an Entire Extension Installation

Junijwi: typos

2020-09-04T07:20:45Z

typos

Junijwi: tfw u forget a bracket

2020-09-04T05:03:45Z

tfw u forget a bracket

Junijwi: there we go

2020-09-04T04:57:11Z

there we go

← Older revision		Revision as of 19:53, 26 January 2022
Line 71:		Line 71:
	===7. Push to Site===		===7. Push to Site===
	Once you have fully tested your new extension on local you can push your changes to your live site! Return to SourceTree and hit the push button!		Once you have fully tested your new extension on local you can push your changes to your live site! Return to SourceTree and hit the push button!
		+
		+
		+	'''Do not push to your site if you have any errors on your local instance, as this will create the same errors on your live site!'''

@@ Line 104: / Line 104: @@
 GIF: [https://i.gyazo.com/2e282c274f6d8407a45d6c6d8ccd3e6a.gif Very quick example of how to edit the conflict in VSC].</blockquote>Once you've used VSC to merge the code manually, the >>> <<<=== HEAD stuff should all be gone, and you should be left with some nice and neat code. '''NOTE:''' Be sure to keep an eye on brackets (that is, (), [], and {} to be sure that your edits do not destroy the hierarchy of the brackets. Every open bracket (left bracket) needs a closing bracket (right bracket) or the code will break. ALSO be sure that you are preserving ; (semicolons) where they need to be (check the surrounding code if they have ; at the end of each line) and for the presence or absence of commas. If you're not sure, you can reference other chunks of code within the same file. Luckily, having these issues will normally cause 500 logs which tell you which file and which line specifically are breaking, so they're easier to troubleshoot if you overlook them (see [[Tutorial: Installing Extensions#Finding an Issue|Finding an Issue]]).<blockquote>IMAGE: [https://i.gyazo.com/4a5562b09be98821fe1d821ed31f1e9f.png Example of paying attention to semicolons and commas].</blockquote>When you go back into Sourcetree, you'll notice that the file no longer has HEAD in it-- it will have changed its view to be more like a normal change, with Red lines marking deletions and Green lines marking additions. You should be able to stage the file now with no consequences (push the '+' to the right of the file name).
-Scrutinize your conflicts mercilessly! When you've gone through every single conflict and your Unstaged files section is empty, you can finally [[Tutorial: Installing Extensions#4b. "Commit" Changes to your local branch|Commit + Push]].
+Scrutinize your conflicts mercilessly! When you've gone through every single conflict and your Unstaged files section is empty, you can finally commit and test locally.
 ==Troubleshooting==

@@ Line 13: / Line 13: @@
 ==Installing==
-Installing can be very fast and simple, but it is important to follow each step carefully and fully before proceeding. Please note that installing multiple extensions can be significantly more complex. Extensions should always be installed one at a time.
+Installing can be very fast and simple, but it is important to follow each step carefully and fully before proceeding. Please note that installing multiple extensions can be significantly more complex. Extensions should always be installed one at a time and fully tested before adding additional extensions.
 ===1. Adding the Extension's Repository as a Remote.===

@@ Line 61: / Line 61: @@
 <br />
-=== 6. Testing ===
+===6. Testing===
 It is important to fully test each extension you install. Launch your local site. To manually test your new extension try out each function of the site that the extension impacts. For example, if you install the advent calendar extension you should test out making an advent calendar, and test out receiving items from it. Thorough local testing can help prevent problems on your live site!
 If you have any issues, see '''[http://wiki.lorekeeper.me/index.php?title=Tutorial:_Installing_Extensions#Troubleshooting Troubleshooting]''' below.
 <br />
-=== 7. Push to Site ===
+===7. Push to Site===
 Once you have fully tested your new extension on local you can push your changes to your live site! Return to SourceTree and hit the push button!
@@ Line 75: / Line 77: @@
 <br />
-=== 8. Complete Set Up ===
+===8. Complete Set Up===
 If the extension you installed requires additional commands you should now run them in Putty.

@@ Line 1: / Line 1: @@
 This tutorial explains how to install Extensions from the [[:Category:Extensions|Extensions Category]] onto your copy of Lorekeeper.
-It is recommended that you at least read '''[http://wiki.lorekeeper.me/index.php?title=Tutorial:_Installing_Extensions#Installing Installing]''' and '''[http://wiki.lorekeeper.me/index.php?title=Tutorial:_Installing_Extensions#Merging_Conflicts Merging]''' sections before attempting to install any extensions. Not scrutinizing merges can have devastating consequences for your site.
+Please read '''[http://wiki.lorekeeper.me/index.php?title=Tutorial:_Installing_Extensions#Installing Installing]''' and '''[http://wiki.lorekeeper.me/index.php?title=Tutorial:_Installing_Extensions#Merging_Conflicts Merging]''' sections before attempting to install any extensions. Not scrutinizing merges can have devastating consequences for your site. It suggested to have a Local instance set up to test your extensions before pushing them to your live site.
 ==Software==
@@ Line 13: / Line 13: @@
 ==Installing==
-Installing is very fast and simple, and the actual installation itself only takes a few minutes.
+Installing can be very fast and simple, but it is important to follow each step carefully and fully before proceeding. Please note that installing multiple extensions can be significantly more complex. Extensions should always be installed one at a time.
 ===1. Adding the Extension's Repository as a Remote.===
@@ Line 46: / Line 46: @@
 ===4b. "Commit" Changes to your local branch===
 If everything looks good to go (you did not get conflicts and none of the files are suspicious), click the '''Commit''' button on the bottom right. This will create a new commit on Sourcetree with your merge.
-Then, click Push!<blockquote>IMAGE: [https://i.gyazo.com/c8d7a86d8fe9b51d42c511d589c00ea4.png Commit and Push your changes].</blockquote>You will be pushing to your website!
+Some add-ons have additional set up. Some will require you to add links to _nav or change settings. Others will require you to run a migration or other commands. This information can be found in the documentation for the extension.
-===5. Extra Setup===
+To run a migration, open command and navigate to your [http://wiki.lorekeeper.me/images/thumb/5/5f/Image17.png/800px-Image17.png site folder] with the below code.
-To run a migration, open Putty and navigate to your site folder: using this code
+<br />
   cd ~/site-name.com/www
-Then run the migration:
+Then enter any commands indicated in the extension’s documentation. Once you have run all required commands your extension should be live on your site!
- php artisan migrate
+<br />
 ==Merging Conflicts==

@@ Line 124: / Line 124: @@
 ===Reversing an Entire Extension Installation===
-'''** NOTE: YOU CAN ONLY DO THIS IF YOUR MOST RECENT ACTION IS INSTALLING THE EXTENSION. IF YOU HAVE DONE ANYTHING ELSE SINCE THEN, DO NOT ATTEMPT TO REVERSE THE INSTALLATION UNLESS YOU KNOW EXACTLY WHAT YOU'RE DOING. **'''
+'''** NOTE: YOU CAN ONLY DO THIS IF YOUR MOST RECENT ACTION IS INSTALLING THE EXTENSION. IF YOU HAVE DONE ANYTHING ELSE SINCE THEN, DO NOT ATTEMPT TO REVERSE THE INSTALLATION UNLESS YOU KNOW EXACTLY WHAT YOU'RE DOING. YOU ARE LIABLE TO BREAK YOUR SITE AND/OR PORTIONS OF ITS FUNCTIONALITY. **'''
 To undo an installation, go to the commit in your history. Right click, then select "Reverse Commit". Click Yes when Sourcetree asks if you'd like to reverse your commit. Then Push to your website, and be sure to check Force Push in order to override the current site's files. If Force Push is not available, you may need to turn it on in your settings.<blockquote>IMAGE: [https://i.gyazo.com/689551bb96025c1a9ee6b695c248469c.png Enabling Force Push].

← Older revision		Revision as of 20:32, 8 July 2021
Line 124:		Line 124:

	===Reversing an Entire Extension Installation===		===Reversing an Entire Extension Installation===
		+	''' NOTE: YOU CAN ONLY DO THIS IF YOUR MOST RECENT ACTION IS INSTALLING THE EXTENSION. IF YOU HAVE DONE ANYTHING ELSE SINCE THEN, DO NOT ATTEMPT TO REVERSE THE INSTALLATION UNLESS YOU KNOW EXACTLY WHAT YOU'RE DOING. '''
		+
	To undo an installation, go to the commit in your history. Right click, then select "Reverse Commit". Click Yes when Sourcetree asks if you'd like to reverse your commit. Then Push to your website, and be sure to check Force Push in order to override the current site's files. If Force Push is not available, you may need to turn it on in your settings.<blockquote>IMAGE: [https://i.gyazo.com/689551bb96025c1a9ee6b695c248469c.png Enabling Force Push].		To undo an installation, go to the commit in your history. Right click, then select "Reverse Commit". Click Yes when Sourcetree asks if you'd like to reverse your commit. Then Push to your website, and be sure to check Force Push in order to override the current site's files. If Force Push is not available, you may need to turn it on in your settings.<blockquote>IMAGE: [https://i.gyazo.com/689551bb96025c1a9ee6b695c248469c.png Enabling Force Push].

@@ Line 56: / Line 56: @@
 Then run the migration:
   php artisan migrate
-It may as you yes/no, type yes.
+It may ask you yes/no, type yes.
 Check your site very quickly to make sure it's still working, and that the new add-ons are doing what they need to be doing. If you have any issues, see '''[http://wiki.lorekeeper.me/index.php?title=Tutorial:_Installing_Extensions#Troubleshooting Troubleshooting]''' below.
@@ Line 77: / Line 77: @@
 Looking at this specific code through Sourcetree, it's confused about how to merge this code. You do NOT want lines of code to needlessly repeat (this can actually cause 500 errors). This specific error is caused because RAFFLES and AWARDS changed the same sections. What you'll want to do is merge them in a way that preserves both. Compare the code to see what is similar and what is different. Sometimes, there will be silly empty incoming/current changes-- this mostly just means Git did a Bad Job Interpreting what happened here, and you can mostly just accept whichever change is not empty.<blockquote>IMAGE: [https://i.gyazo.com/201e8d2cad18ae98b06284c8026ea4cd.png Using VSC to compare code].
-GIF: [https://i.gyazo.com/2e282c274f6d8407a45d6c6d8ccd3e6a.gif Very quick example of how to edit the conflict in VSC].</blockquote>Once you've used VSC to merge the code manually, the >>> <<<=== HEAD stuff should all be gone, and you should be left with some nice and neat code. '''NOTE:''' Be sure to keep an eye on brackets (that is, (), [], and {} to be sure that your edits do not destroy the hierarchy of the brackets. Every open bracket (left bracket) needs a closing bracket (right bracket) or the code will break. ALSO be sure that you are preserving ; (semicolons) where they need to be (check the surrounding code if they have ; at the end of each line) and for the presence of absence of commas. If you're not sure, you can reference other chunks of code within the same file. Luckily, having these issues will normally cause 500 logs which tell you which file and which line specifically are breaking, so they're easier to troubleshoot if you overlook them (see [[Tutorial: Installing Extensions#Finding an Issue|Finding an Issue]]).<blockquote>IMAGE: [https://i.gyazo.com/4a5562b09be98821fe1d821ed31f1e9f.png Example of paying attention to semicolons and commas].</blockquote>When you go back into Sourcetree, you'll notice that the file no longer has HEAD in it-- it will have changed its view to be more like a normal change, with Red lines marking deletions and Green lines marking additions. You should be able to stage the file now with no consequences (push the '+' to the right of the file name).
+GIF: [https://i.gyazo.com/2e282c274f6d8407a45d6c6d8ccd3e6a.gif Very quick example of how to edit the conflict in VSC].</blockquote>Once you've used VSC to merge the code manually, the >>> <<<=== HEAD stuff should all be gone, and you should be left with some nice and neat code. '''NOTE:''' Be sure to keep an eye on brackets (that is, (), [], and {} to be sure that your edits do not destroy the hierarchy of the brackets. Every open bracket (left bracket) needs a closing bracket (right bracket) or the code will break. ALSO be sure that you are preserving ; (semicolons) where they need to be (check the surrounding code if they have ; at the end of each line) and for the presence or absence of commas. If you're not sure, you can reference other chunks of code within the same file. Luckily, having these issues will normally cause 500 logs which tell you which file and which line specifically are breaking, so they're easier to troubleshoot if you overlook them (see [[Tutorial: Installing Extensions#Finding an Issue|Finding an Issue]]).<blockquote>IMAGE: [https://i.gyazo.com/4a5562b09be98821fe1d821ed31f1e9f.png Example of paying attention to semicolons and commas].</blockquote>When you go back into Sourcetree, you'll notice that the file no longer has HEAD in it-- it will have changed its view to be more like a normal change, with Red lines marking deletions and Green lines marking additions. You should be able to stage the file now with no consequences (push the '+' to the right of the file name).
 Scrutinize your conflicts mercilessly! When you've gone through every single conflict and your Unstaged files section is empty, you can finally [[Tutorial: Installing Extensions#4b. "Commit" Changes to your local branch|Commit + Push]].

@@ Line 119: / Line 119: @@
 '''Extensions''': [what extensions you recently added that may be related]
-'''Error''' '''Log''': [the error in the log, copy pasted
+'''Error''' '''Log''': [the error in the log, copy pasted]
 '''Code:''' [If your error log talks about a specific line of code, please copy paste it between ``` - ``` or share it in a [https://pastebin.com/ pastebin].]</blockquote>

@@ Line 100: / Line 100: @@
 Any time you hit a 500 error on your site, you will want to 'pull the logs'. Using [https://filezilla-project.org/ Filezilla] or some other FTP client is the easiest way to do this. Navigate to the following folder:
   /site-name.com/www/storage/logs
-and find a file with a name formatted like '''laravel-yyyy-mm-dd''' such as laravel-2020-08-30 for example. The date should match today's date. Open it (with notepad, visual studio, whatever text editor, doesn't need to be complex) and you will see a mess of text. These are all your error logs. The top is the oldest, and the bottom are the most recent, so scroll all the way to the bottom. You will notice that they are formatted in a certain way:<blockquote>```[yyyy-mm-dd hh:mm:ss] type of ERROR: description of the error and files/lines related to that error going on for several long or short lines.```
+and find a file with a name formatted like '''laravel-yyyy-mm-dd''' such as laravel-2020-08-30 for example. The date should match today's date. Open it (with notepad, visual studio, whatever text editor, doesn't need to be complex) and you will see a mess of text. These are all your error logs. The top is the oldest, and the bottom are the most recent, so scroll all the way to the bottom. You will notice that they are formatted in a certain way:<syntaxhighlight>
 #0 A bunch of indiscernable laravel nonsense
 #1 Which continues for like 50 of these lines
 #3 Depending on how complex your problem is
 #4 etc etc
-#4 etc etc<nowiki></code></nowiki></blockquote>The important part is the entire section from the [date] ending before the #0. That is your basic error code!
+</syntaxhighlight>The important part is the entire section from the [date] ending before the #0. That is your basic error code!
 The error log will often talk about any problematic variables, missing information, or broken coding (demanding } or ;). It will also sometimes throw the location of a specific file in the format of