Browse Source

Update troubleshooting info

shalvah 4 years ago
parent
commit
e1c790e1e1
2 changed files with 9 additions and 3 deletions
  1. 4 3
      .github/ISSUE_TEMPLATE/bug_report.md
  2. 5 0
      docs/troubleshooting.md

+ 4 - 3
.github/ISSUE_TEMPLATE/bug_report.md

@@ -21,9 +21,10 @@ instead of...
 
 
 
 
 **My environment:**
 **My environment:**
- - PHP version: 
- - Framework (Laravel/Lumen) and version: 
- - Scribe Version: 
+ - PHP version (from `php -v`): 
+ - Framework (Laravel/Lumen):
+ - Laravel/Lumen version (from `composer show laravel/framework` or `composer show lumen/framework`): 
+ - Scribe version (from `composer show knuckleswtf/scribe`): 
 
 
 **My Scribe config (minus the comments):**
 **My Scribe config (minus the comments):**
 
 

+ 5 - 0
docs/troubleshooting.md

@@ -1,6 +1,11 @@
 # Troubleshooting and Debugging
 # Troubleshooting and Debugging
 This page contains a few tips to help you figure out what's wrong when Scribe seems to be malfunctioning.
 This page contains a few tips to help you figure out what's wrong when Scribe seems to be malfunctioning.
 
 
+## Update your installation
+First off, try updating your installed Scribe version. Maybe your problem is due to a bug we've fixed in a newer release. You can see a list of releases and major changes on [the changelog](https://github.com/knuckleswtf/scribe/blob/master/CHANGELOG.md).
+- To find the exact 
+- To update to the latest version, run `composer update knuckleswtf/scribe`. To update to a specific version (example: 1.4.1), run `composer update knuckleswtf/scribe:1.4.1`.
+
 ## Increase the verbosity
 ## Increase the verbosity
 By default, Scribe will try to keep going until it processes all routes and generates your docs. If it encounters any problems while processing a route (such as a missing `@responseFile`, or some invalid configuration leading to an exception being thrown), it will output a warning and the exception message, then move on to the next route.
 By default, Scribe will try to keep going until it processes all routes and generates your docs. If it encounters any problems while processing a route (such as a missing `@responseFile`, or some invalid configuration leading to an exception being thrown), it will output a warning and the exception message, then move on to the next route.