Merge pull request #154 from gobuffalo/docs-on-gopath-bin

added docs about the GOPATH/bin issue
gobuffalo · Feb 4, 2018 · 346b866 · 346b866
2 parents b094679 + c24ec5e
commit 346b866
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 1 deletion.
diff --git a/templates/docs/installation.fr.md b/templates/docs/installation.fr.md
@@ -9,6 +9,7 @@ Buffalo fournit **deux composants majeurs** :
 Avant d'installer Buffalo, assurez-vous d'avoir installé les dépendances suivantes :
 
 * [Guide de configuration d'un environnement de développement Go (EN)](http://gopherguides.com/before-you-come-to-class).
+* [Une variable d'environnement `$PATH` correctement configurée, incluant `$GOPATH/bin`](https://golang.org/doc/code.html#GOPATH).
 * [Go](https://golang.org) version `<%= goMinVersion %>` ou supérieure.
 
 ##### Prérequis pour le frontend

diff --git a/templates/docs/installation.md b/templates/docs/installation.md
@@ -12,6 +12,7 @@ Buffalo provides **two major components**:
 Before installing make sure you have the required dependencies installed:
 
 * [Guide to Setting a Go Developer Environment](http://gopherguides.com/before-you-come-to-class)
+* [A configured `$PATH` environment variable that includes `$GOPATH/bin`.](https://golang.org/doc/code.html#GOPATH)
 * [Go](https://golang.org) version `<%= goMinVersion %>` or greater.
 
 ##### Frontend Requirements

diff --git a/templates/docs/troubleshooting.html b/templates/docs/troubleshooting.html
@@ -3,6 +3,9 @@
 <div class="faq">
   <input class="faq-search" type="text" placeholder="Type to search...">
   <ul>
+    <%= faq("Can't find `buffalo` binary.") { %>
+If you can't find the `buffalo` binary after a successful installation, this is problably caused because `$GOPATH/bin`, or `%GOPATH\bin` (Windows), isn't in your `$PATH` variable. When a Go binary is installed it is placed in `$GOPATH/bin`. Adding this to your global `$PATH` will allow you to find **any** Go binary everywhere in your system. See [https://golang.org/doc/code.html#GOPATH](https://golang.org/doc/code.html#GOPATH) for more details.
+    <% } %>
 
     <%= faq("`buffalo new` fails to generate a complete project.") { %>
 This happens because the `buffalo new` command cannot find the templates it needs to generate a new application.
@@ -106,7 +109,7 @@
 
 Error: exit status 1
 ```
-    <% } 
+    <% }
 
     <%= faq("`buffalo g goth` fails to generate `auth.go`") { %>
 You might see errors similar to this when you build: